Continue improving doc page#180
Merged
Merged
Conversation
22 tasks
Collaborator
Author
|
/ok to test d3961f6 |
Collaborator
Author
|
/ok to test 7e07312 |
janickm
reviewed
May 27, 2026
janickm
approved these changes
May 27, 2026
Collaborator
janickm
left a comment
janickm
left a comment
There was a problem hiding this comment.
Thanks for incorporating the suggestions @liruilong940607 !
aidanfnv
added a commit
that referenced
this pull request
May 29, 2026
- Master toctree in docs/source/index.rst rewritten to four entries: Get Started, Documentation, Benchmarks, Community. - Landing page (docs/source/index.rst) trimmed to the five sections specified by the project lead: title with CTAs immediately under the H1, Why FlashDreams, Performance (merge of the prior Headline numbers + How it compares), Try FlashDreams, Supported models. Removed Born from OmniDreams (closes a thread from #163 / #180 that had already de-emphasized the OmniDreams origin story on main). Aspirational subtitles and the NVIDIA-led framing in the hero lede are dropped; tone reworked across landing, benchmarks, community for matter-of-fact technical prose. Visual placeholders preserved in three sections: hero loop (AVIF), Why FlashDreams architecture diagram (SVG light + dark), and a four-tile sample rail above the supported-models grid. - Quickstart consolidated to a single Get Started page; the prior installation.rst and first_world_model.rst sub-pages are folded into docs/source/quickstart/index.rst. - New docs/source/documentation/index.rst umbrella becomes the Documentation tab landing, routing into developer_guides/ and api/. docs/source/_templates/layout.html render-mode switch extended so api/*, documentation/*, and developer_guides/* all use the pydata docs scaffold (sidebar-nav-bs + page-toc + article container); everything else stays full-bleed marketing-flow. conf.py html_sidebars and secondary_sidebar_items updated to match. documentation/index.rst and developer_guides/index.rst rewritten in docs-scaffold style (plain titles, plain sphinx_design cards, no fd-* marketing components). - docs/source/models/index.rst removed; supported-models gallery absorbed into docs/source/benchmarks/index.rst with a :hidden: toctree listing the 8 per-model sub-pages so they remain reachable from the Benchmarks tab. - Discord invite URL (https://discord.com/invite/nvidiaomniverse) wired into footer icon_links and into the in-page community surfaces (community/index.rst Where-to-find-us tile, community/faq.rst lede, community/support.rst question card + callout). GitHub + Discord icon links in the footer use FontAwesome brand SVGs via html_theme_options icon_links; footer CSS in _static/custom.css. - Cross-reference cleanup: every prior :doc:`/models/index` retargets to :doc:`/benchmarks/index`; the two refs to the deleted /quickstart/first_world_model retarget to /quickstart/index. - Bug fix already on the branch carried forward: entry-point group name is flashdreams.runner_configs (was flashdreams.runners on a stale info-card on models/index). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
2 participants
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.
Address feedbacks in #163