Website: Migrate to new public-facing site#284
Conversation
…nity pages What this change does: - Adapts the index page of the docs into a landing page for a public-facing website - Changes the website theme from furo to pydata - Includes easy navigation to the supported models listed on the landing page - Adapts existing text from the docs and current website where possible - Loses the documentation-style layout for non-documentation pages, only including sidebars where they provide a clear benefit - Adds a "Documentation" page to consolidate the Developer Guides and API/CLI References into a single landing What this change does not do (for follow-up changes): - Rewrite any of the API documentation or developer guides (#229) - Consolidate the quick-start guides into a "Get Started" page (#246) - Implement the "Benchmarks" page, currently it links to the model cards index (#267) - Replace the current website, since this is going into a separate branch until the follow-ups land (#284)
481193c to
499919f
Compare
…nity pages What this change does: - Adapts the index page of the docs into a landing page for a public-facing website - Changes the website theme from furo to pydata - Includes easy navigation to the supported models listed on the landing page - Adapts existing text from the docs and current website where possible - Loses the documentation-style layout for non-documentation pages, only including sidebars where they provide a clear benefit - Adds a "Documentation" page to consolidate the Developer Guides and API/CLI References into a single landing What this change does not do (for follow-up changes): - Rewrite any of the API documentation or developer guides (#229) - Consolidate the quick-start guides into a "Get Started" page (#246) - Implement the "Benchmarks" page, currently it links to the model cards index (#267) - Replace the current website, since this is going into a separate branch until the follow-ups land (#284)
Greptile SummaryThis PR migrates the FlashDreams documentation site from the Furo theme to pydata-sphinx-theme, introducing a marketing-style homepage layout alongside conventional reference-doc pages, and reorganises content into five top-level sections: Get Started, Documentation, Models, and Contribute.
Confidence Score: 5/5Safe to merge — changes are entirely documentation and build infrastructure with no impact on runtime behaviour The PR touches only docs source files, CSS/JS assets, and pyproject.toml dependency groups. The one notable behavioural change is the custom search tokenizer: it correctly fixes hyphenated-command ranking, but the new split() bypasses stemming and lowercasing, which may silently degrade natural-language search relevance. This is a documentation UX concern, not a runtime defect, and the rest of the restructure is well-executed with consistent use of sphinx-design components and CSS design tokens. docs/source/conf.py — the _SearchEnglishHyphenated.split() method warrants a second look to confirm the stemming trade-off is intentional Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[index.rst\nHomepage - marketing layout] --> B[quickstart/index.rst\nGet Started]
A --> C[documentation.rst\nDocumentation landing]
A --> D[models/index.rst\nModels gallery]
A --> E[community/index.rst\nContribute]
C --> C1[developer_guides/index.rst]
C --> C2[api/index.rst]
C --> C3[troubleshooting.rst]
D --> D1[omnidreams.rst]
D --> D2[self_forcing.rst]
D --> D3[causal_forcing.rst]
D --> D4[causal_wan22.rst]
D --> D5[lingbot_world.rst]
D --> D6[flashvsr.rst]
D --> D7[wan21.rst]
D --> D8[cosmos_predict2.rst]
E --> E1[support.rst - Getting help]
E --> E2[discord.rst]
E --> E3[faq.rst]
style A fill:#5e9400,color:#fff
style B fill:#4b7600,color:#fff
style C fill:#4b7600,color:#fff
style D fill:#4b7600,color:#fff
style E fill:#4b7600,color:#fff
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
A[index.rst\nHomepage - marketing layout] --> B[quickstart/index.rst\nGet Started]
A --> C[documentation.rst\nDocumentation landing]
A --> D[models/index.rst\nModels gallery]
A --> E[community/index.rst\nContribute]
C --> C1[developer_guides/index.rst]
C --> C2[api/index.rst]
C --> C3[troubleshooting.rst]
D --> D1[omnidreams.rst]
D --> D2[self_forcing.rst]
D --> D3[causal_forcing.rst]
D --> D4[causal_wan22.rst]
D --> D5[lingbot_world.rst]
D --> D6[flashvsr.rst]
D --> D7[wan21.rst]
D --> D8[cosmos_predict2.rst]
E --> E1[support.rst - Getting help]
E --> E2[discord.rst]
E --> E3[faq.rst]
style A fill:#5e9400,color:#fff
style B fill:#4b7600,color:#fff
style C fill:#4b7600,color:#fff
style D fill:#4b7600,color:#fff
style E fill:#4b7600,color:#fff
Reviews (18): Last reviewed commit: "Website: Migrate to new public-facing si..." | Re-trigger Greptile |
janickm
left a comment
There was a problem hiding this comment.
Could you also try to reduce the number of commits please (likely we don't need the full history of 33 ones?)
Other that that I only left cosmetic suggestions to tidy up the representation, mainly to make all pages look + feel fully consistent (which they are currently not yet fully)
[approving already]
I could squash most of these commits together and force-push to here before merging, but either way I will squash them when I merge. |
0744f0f to
9c5a891
Compare
9c5a891 to
a845d64
Compare
|
/ok to test 75c6d48 |
|
/ok to test 7cfcb18 |
Preview: https://nvidia.github.io/flashdreams/pr-preview/after/ Changes the site theme, with different layouts depending on the page's content, purpose, and audience, and reorganizes the site into 5 sections: 1. Landing/home page, which consists of: - A headline section, which uses auto-playing looping AVIF instead of video embed - Why FlashDreams? - "Performance" as a summary of some benchmarks from the "Models" section - "Try FlashDreams!" with links to the "Get Started" section - "Supported Models" with a glimpse of what models are in the "Models" section 2. Get Started: - Consolidates the quickstart pages into a single "Get Started" page 3. Documentation: - "Documentation" links to a landing page for the developer guides index page, the api/cli references index page, and the troubleshooting page - Rewrites the index pages for the developer guides and api/cli references to use grids summarizing the contents - Makes some prose changes to the developer guides to use more second person language and fix some typos - Incorporates the troubleshooting doc into the documentation section and adds a link to it from the community support page 4. Models, which rewrites the existing models index page to include: - Gallery of available models, with sample clips - 2 categories of benchmarks: Autoregressive and Bidirectional vs Upstream, and Super-resolution - Benchmark methodology - How to run a model yourself (content from the original page) 5. Contribute, which includes: - "Contribute" links to the contents of CONTRIBUTE.md, but there are additional support/contributing docs linked from there, including the existing Discord doc - "Getting Help" doc to guide users to the right place should they have problems - FAQ doc Also changes the Sphinx search functionality to respect hyphens, so for example flashdreams-run actually searches for flashdreams-run instead of searching for flashdreams and/or run.
7cfcb18 to
b058f8e
Compare
|
/ok to test b058f8e |
Preview: https://nvidia.github.io/flashdreams/pr-preview/after/
Changes the site theme, with different layouts depending on the page's content, purpose, and audience, and reorganizes the site into 5 sections:
CONTRIBUTE.md, but there are additional support/contributing docs linked from there, including the existing Discord docAlso changes the Sphinx search functionality to respect hyphens, so for example
flashdreams-runactually searches forflashdreams-runinstead of searching forflashdreamsand/orrun.