feat(site): GitHub Pages — cosmic-green landing + MkDocs Material docs#149
Merged
Conversation
Adds a public GitHub Pages site with two parts, assembled into _site/ by a single build script used both locally and in CI: - web/ — hand-crafted, brand-matched landing page (firefly hero, stats band, tabbed pre-highlighted code, philosophy, architecture/patterns/ecosystem brand diagrams, 39-module layered grid, quickstart, book, footer). Self-contained, relative URLs, prefers-reduced-motion aware. Install uses the GitHub raw install.sh URL. - mkdocs.yml + overrides/ + docs/stylesheets/pyfly.css + docs/assets/pyfly-mark.svg — MkDocs Material rendering the existing docs/ (layered nav over 43 module + 10 adapter pages), cosmic-green theme, Maven Pro headings, dark mode, search; the docs logo links back to the landing page. - scripts/build_site.py — assembles landing + brand assets + docs build into _site/. - .github/workflows/pages.yml — build + deploy to GitHub Pages. Served at https://fireflyframework.github.io/fireflyframework-pyfly/ (base path aware; easy to repoint at pyfly.io later). Requires a one-time repo setting: Settings -> Pages -> Source: GitHub Actions.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
A public GitHub Pages site for PyFly, in two parts:
web/) — a hand-crafted, brand-matched single page in the cosmic-green firefly identity: animated firefly hero, an at-a-glance stats band, a tabbed pre-highlighted code panel (DI · CQRS · Saga), the four philosophy pillars, the existing architecture / hexagonal / auto-config / distributed-patterns / ecosystem brand diagrams, a 39-module layered grid, the 4-step quickstart, a PyFly by Example book callout, and a footer. Self-contained, relative URLs,prefers-reduced-motionaware.mkdocs.yml+overrides/+docs/stylesheets/pyfly.css+docs/assets/pyfly-mark.svg) — MkDocs + Material rendering the existingdocs/*.mdwith a layered nav over 43 module + 10 adapter pages, a cosmic-green palette, Maven Pro headings, dark mode, and client-side search. The docs logo links back to the landing page.Both are assembled into
_site/byscripts/build_site.py— the single source of truth used identically locally and in CI — and deployed by.github/workflows/pages.yml.URL & base path
Served at
https://fireflyframework.github.io/fireflyframework-pyfly/(docs at…/docs/). The landing page uses relative URLs and the docs config is base-path-aware, so repointing atpyfly.iolater is a CNAME + two config values.Settings → Pages → Source: GitHub Actions. After that, merging to
maindeploys automatically (the workflow triggers onpushtomainand on manual dispatch). Pushing this branch does not deploy.Preview locally
pip install -r requirements-docs.txt python scripts/build_site.py python -m http.server -d _site 8000 # → http://localhost:8000/Verification
build_site.pybuilds cleanly (docs compile in ~2.5s); every landing → docs link target resolves underuse_directory_urls.#1f5e16, Maven Pro headings, firefly logo linking home, working search). No console errors.README/book.yaml/CHANGELOG/pyproject.toml/samples/lumen— version, "18 chapters in five parts", Lumen wallet & ledger, 39 modules across 5 layers, the six patterns, code samples, CLI archetypes/commands, and the ecosystem family all verified accurate.Notes / possible follow-ups
docs/superpowers/and the duplicatedocs/README.mdare excluded from the public docs.pyfly-logo.pngused for OG/social.