docs: site redesign (Maven Pro banner + theme) and The Complete Guide PDF#8
Merged
Conversation
added 7 commits
June 25, 2026 16:56
…aths Convert the wordmark to real Maven Pro vector paths (HarfBuzz shaping + fontTools outlines) so it renders identically on GitHub, MkDocs and in the WeasyPrint PDF with zero font dependency — the house-style way. Adds a compact nav logo glyph and a favicon, generated by assets/tools/gen_banner.py.
Add docs/stylesheets/firefly.css: heading=Maven Pro, body=Inter, code= JetBrains Mono; cyan brand tokens for light+dark; hero, grid-card glow, code/table/blockquote polish; a custom amber 'firefly' admonition that marks the 'LLM proposes, classical decides' thesis. Wire logo/favicon to the new glyph assets and extra_css in mkdocs.yml.
…st extensions Add navigation.tabs(+sticky/tracking/indexes), instant.progress, content.tooltips, search.share. Enable pymdownx.tasklist/emoji/keys + footnotes (emoji powers Material icons in grid cards). Add extra.social (GitHub, Firefly Agentic, PyPI) and generator:false.
Rebuild index.md around a hero (banner + CTA buttons), the pillars as icon grid-cards, a tabbed 30-second start, and a section card grid. Move the 'LLM proposes, classical decides' thesis into the firefly admonition. Add a visually-hidden h1 (real page title, banner as masthead) + hide the homepage TOC; add the .firefly-sr-only utility.
Restructure every page to a consistent skeleton (bold lede, Material features, 'See also' footer) and expand where it helps: numbered steps, content tabs, code annotations, expected-output callouts, and the amber 'firefly' thesis callout (16 pages). Each page was rewritten grounded in src/ and then adversarially fact-checked; review caught and fixed real issues — quickstart now uses TaskType.BINARY so roc_auc is the correct default metric; architecture states ports live in their domain modules (not a central package) and drops a nonexistent CodeExecutorPort; samples restores the offline runtime hint.
Replace the business-only Strategic Introduction with a 60-page combined guide (strategy + architecture + full hands-on tutorial + reference), built with the document-forge pipeline: cyan-forward brand matching the banner, 12 custom HTML/CSS figures, a numbered TOC and auto-numbered figures. Every benchmark number is grounded in benchmarks/RESULTS.md and the technical claims were fact-checked against src/. Update the homepage + README links.
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.
Overhauls the documentation experience and ships a new combined strategy+technical guide.
Docs site
banner.svg, a firefly-hublogo.svgandfavicon.svg, generated byassets/tools/gen_banner.py.docs/stylesheets/firefly.css: Maven Pro headings · Inter body · JetBrains Mono code; cyan brand tokens (light + dark); hero, grid-card glow, code/table/admonition polish; a custom amberfireflyadmonition marking the "LLM proposes, classical engine decides" thesis.src/and then adversarially fact-checked (the review caught and fixed real issues, e.g.roc_auc→TaskType.BINARYand a ports-location claim).The Complete Guide (PDF)
docs/brief/firefly-datascience-complete-guide.pdf).benchmarks/RESULTS.md; technical claims fact-checked againstsrc/. Verified by rendering the PDF and reading the pages.All
mkdocs build --strictbuilds pass.