Add GitHub Pages site — landing + MkDocs docs (correct install instructions)#309
Merged
Conversation
added 2 commits
June 25, 2026 14:45
- MkDocs Material site: a custom dark "firefly-in-the-dark" landing (overrides/home.html, firefly.css, firefly-constellation canvas) over the existing 28 docs, with search, light/dark and the violet brand theme. - New Getting-Started pages (installation, quickstart, jupyter) and an in-site changelog that snippet-includes CHANGELOG.md. - GitHub Actions (.github/workflows/docs.yml) builds with `--strict` and deploys to GitHub Pages on push to main. - Fix cross-file and GitHub-style anchor links so `mkdocs build --strict` passes clean (architecture, agents, reasoning, pipeline, tutorial, changelog). - Correct install instructions: the package is NOT published on PyPI. Replace every `pip install fireflyframework-agentic` with the curl installer / from-source (uv sync) — in the landing hero, the installation page, the architecture diagram label (+ its generator) and the README alt text; remove the PyPI social link. One-time manual step to go live: Settings -> Pages -> Source: GitHub Actions.
mkdocs.yml uses Material's !!python/name: tags (mermaid superfence), which check-yaml cannot construct. mkdocs build --strict validates it instead. Mirrors the existing check-json exclude for tsconfig files.
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
1 participant
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.
Summary
Adds a public GitHub Pages site, built with MkDocs Material:
overrides/home.html+docs/stylesheets/firefly.css+ a firefly-constellation canvas) over the existing 28 docs, with search, light/dark and the violet brand.CHANGELOG.md)..github/workflows/docs.yml) builds with--strictand deploys to Pages on push tomain.Install instructions corrected
The package is not published on PyPI, so every
pip install fireflyframework-agenticis replaced with the curl installer / from-source (uv sync) — landing hero, install page, the architecture diagram label (+ its generator) and README alt text; removed the dead PyPI link.Verification
mkdocs build --strict→ exit 0, zero warnings (fixed 5 cross-file / GitHub-style anchor links).Going live
Pages source is set to GitHub Actions. After merge, the
docsworkflow deploys tohttps://fireflyframework.github.io/fireflyframework-agentic/