Skip to content

Website: Migrate to new public-facing site#284

Merged
aidanfnv merged 1 commit into
mainfrom
dev/aidanf/flashdreams-site
Jun 17, 2026
Merged

Website: Migrate to new public-facing site#284
aidanfnv merged 1 commit into
mainfrom
dev/aidanf/flashdreams-site

Conversation

@aidanfnv

@aidanfnv aidanfnv commented Jun 3, 2026

Copy link
Copy Markdown
Collaborator

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
  1. Get Started:
  • Consolidates the quickstart pages into a single "Get Started" page
  1. Documentation:
  • "Documentation" links to a landing page for the devleoper 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
  1. 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)
  1. 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.

@copy-pr-bot

copy-pr-bot Bot commented Jun 3, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

aidanfnv added a commit that referenced this pull request Jun 8, 2026
…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)
@aidanfnv aidanfnv force-pushed the dev/aidanf/flashdreams-site branch from 481193c to 499919f Compare June 11, 2026 22:41
aidanfnv added a commit that referenced this pull request Jun 11, 2026
…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)
@NVIDIA NVIDIA deleted a comment from github-actions Bot Jun 11, 2026
@aidanfnv aidanfnv marked this pull request as ready for review June 11, 2026 22:44
@greptile-apps

greptile-apps Bot commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This 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.

  • Theme and layout: replaces Furo with pydata-sphinx-theme 0.18; layout.html switches between a full-bleed marketing scaffold (homepage) and the standard pydata docs scaffold (all other pages) based on pagename; design tokens and all component CSS are rebuilt from scratch with proper --fd-* CSS variables that cover both light and dark modes.
  • Content restructure: the two separate quickstart pages are merged into a single "Get Started" page; a new documentation.rst landing page routes to developer guides, API reference, and troubleshooting; models/index.rst gains a video gallery and benchmark sections; three new community pages (FAQ, support, contribute) are added; the old first_world_model.rst and installation.rst are deleted.
  • Search improvement: a custom _SearchEnglishHyphenated subclass registers as the en search language so that hyphenated CLI commands like flashdreams-run are indexed as a cohesive token in addition to their parts, fixing the ranking problem where incidental "run" headings outranked the actual command pages.

Confidence Score: 5/5

Safe 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

Filename Overview
docs/source/conf.py Migrates theme from Furo to pydata-sphinx-theme, adds GA4 via theme option, adds custom search tokenizer that improves hyphenated CLI searches but introduces a stemming/case-normalisation regression for all prose search terms
docs/source/_templates/layout.html Adds render-mode switch: reference docs get pydata default scaffold, marketing pages get full-bleed fd-landing-main; homepage-only Supported Models rail included via template component
docs/source/index.rst Complete homepage rewrite: replaces custom HTML divs with RST sphinx-design grid/card components for hero, feature cards, performance stats, and model gallery; collapses old toctrees into a single flat 4-entry master toctree
docs/source/_static/js/supported_models_nav.js New script: populates the homepage right-hand model-list rail from the on-page card grid; no-ops silently on any page that lacks both the aside and the Supported Models section
docs/source/_static/custom.css Full CSS rewrite: introduces design-token system (--fd-* variables with proper light/dark variants), pydata-sphinx-theme token overrides, marketing layout components (hero, feature cards, CTA row, stat tiles), and the Supported Models nav rail
docs/source/models/index.rst Adds toctree, rewrites with video gallery cards grouped into streaming/bidirectional/super-resolution categories, benchmark sections, and a running-a-model section
docs/source/quickstart/index.rst Consolidates installation and first-run pages into one Get Started page using OmniDreams as the worked example; removes :orphan: designation
docs/source/documentation.rst New landing page for the Documentation nav entry; grid of three cards (developer guides, API reference, troubleshooting) plus a toctree for those three sections
docs/source/community/index.rst New community landing page that includes CONTRIBUTING.md via myst_parser; toctree covers support, discord, and FAQ pages
pyproject.toml Swaps furo for pydata-sphinx-theme>=0.18 in the docs group; adds sphinx>=7.0 to the lint group so that conf.py sphinx.search imports resolve during linting

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
Loading
%%{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
Loading

Reviews (18): Last reviewed commit: "Website: Migrate to new public-facing si..." | Re-trigger Greptile

Comment thread README.md Outdated
Comment thread .github/workflows/doc-preview.yaml Outdated
@aidanfnv aidanfnv requested a review from janickm June 16, 2026 14:05

@janickm janickm left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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]

Comment thread .github/workflows/doc-preview.yaml Outdated
Comment thread docs/source/_templates/components/supported-models-nav.html
Comment thread docs/source/index.rst Outdated
Comment thread docs/source/documentation.rst
Comment thread docs/source/models/index.rst
Comment thread docs/source/documentation.rst
@aidanfnv

Copy link
Copy Markdown
Collaborator Author

Could you also try to reduce the number of commits please (likely we don't need the full history of 33 ones?)

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.

@aidanfnv aidanfnv force-pushed the dev/aidanf/flashdreams-site branch from 0744f0f to 9c5a891 Compare June 16, 2026 20:37
Comment thread flashdreams/flashdreams/recipes/wan/autoencoder/vae.py
@aidanfnv aidanfnv force-pushed the dev/aidanf/flashdreams-site branch from 9c5a891 to a845d64 Compare June 16, 2026 21:58
@aidanfnv

Copy link
Copy Markdown
Collaborator Author

/ok to test 75c6d48

@aidanfnv

Copy link
Copy Markdown
Collaborator Author

/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.
@aidanfnv aidanfnv force-pushed the dev/aidanf/flashdreams-site branch from 7cfcb18 to b058f8e Compare June 16, 2026 23:13
@aidanfnv

Copy link
Copy Markdown
Collaborator Author

/ok to test b058f8e

@aidanfnv aidanfnv added this pull request to the merge queue Jun 16, 2026
Merged via the queue into main with commit 548cf18 Jun 17, 2026
6 checks passed
@aidanfnv aidanfnv deleted the dev/aidanf/flashdreams-site branch June 17, 2026 00:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants