Skip to content

[Documentation] Further Clean-Up Website + Auto-Doc API Tooling - #727

Merged
ArielG-NV merged 16 commits into
NVIDIA:mainfrom
ArielG-NV:docs-cleanup-website-content
Oct 20, 2026
Merged

ArielG-NV merged 16 commits into
NVIDIA:mainfrom
ArielG-NV:docs-cleanup-website-content

Conversation

@ArielG-NV

@ArielG-NV ArielG-NV commented Oct 16, 2026 •

Copy link
Copy Markdown
Collaborator

Related to but does not resolve #565
Changes:

  • API documentation
    • Replace manual API references with generated Python documentation.
    • Add an Accelerated API reference and remove outdated pages.
  • Developer guides
    • Rewrite demo creation, model adapter, and configuration guides.
    • Update model integration, streaming inference, and serving guidance.
  • Documentation organization
    • Move testing and benchmarking guidance into the website.
    • Simplify READMEs, contribution guidance, and community navigation.
  • Documentation tooling
    • Configure mkdocstrings and add checks for links and navigation consistency.

Not Done Yet:

  • Fix agent skills to point to website *.md#section as single source of truth.
  • Remove loose markdown files outside website or mandatory locations in-favor of having website as source-of-truth
  • Remove Sphynx doc styling to fix all api-docs and their formatting
  • Nicer guide visuals for website
  • Nicer formatting for Inferencing API guide

@ArielG-NV
ArielG-NV requested a review from a team as a code owner October 16, 2026 19:27
@copy-pr-bot

copy-pr-bot Bot commented Oct 16, 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.

ArielG-NV and others added 2 commits October 16, 2026 12:30
Signed-off-by: ArielG-NV <159081215+ArielG-NV@users.noreply.github.com>
@ArielG-NV
ArielG-NV marked this pull request as draft October 16, 2026 19:34
@greptile-apps

greptile-apps Bot commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Medium impact] The PR appears safe to merge, with two non-blocking findings from the previous review still open.

Findings

  1. P2 Configuration example lacks an import ▶
  2. P2 Existing demos lose packaging checks ▶

Summary

This PR replaces manual API references with generated documentation, adds the Minimal T2V tutorial app and Wan adapter, and reorganizes website guides.

  • The Minimal T2V app turns prompts into video blocks with a Wan 2.1 model.
  • API pages now build their references from the Python objects they describe.
  • Website guides now explain how to use, build, and test FlashDreams.
  • The website navigation and link checks now cover the reorganized pages.

Reviews (6) · Last reviewed commit: "format" · Reviewed by Greptile

Comment thread tests/test_docs_links.py Outdated
Comment thread docs/source/documentation/demo_api/guides/create_demo.md Outdated
Comment thread docs/source/documentation/demo_api/guides/create_demo.md Outdated
Comment thread README.md Outdated
@ArielG-NV
ArielG-NV marked this pull request as ready for review October 17, 2026 01:12
Comment on lines +76 to +80
PIPELINE_WAN21_T2V_SEED123 = derive_config(
PIPELINE_WAN21_T2V_1PT3B_480P,
name="wan21-t2v-1.3b-480p-seed123",
diffusion_model={"seed": 123},
)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 Configuration example lacks an import

The example calls derive_config, but integrations_v2/wan21/config.py does not import it. Adding this snippet as instructed makes wan21.config raise NameError, so neither Wan demo can start. Include from flashdreams.infra.config import derive_config in the example.

Suggested change
PIPELINE_WAN21_T2V_SEED123 = derive_config(
PIPELINE_WAN21_T2V_1PT3B_480P,
name="wan21-t2v-1.3b-480p-seed123",
diffusion_model={"seed": 123},
)
from flashdreams.infra.config import derive_config
PIPELINE_WAN21_T2V_SEED123 = derive_config(
PIPELINE_WAN21_T2V_1PT3B_480P,
name="wan21-t2v-1.3b-480p-seed123",
diffusion_model={"seed": 123},
)

@jmccaffrey-nv

Copy link
Copy Markdown
Collaborator

/ok to test 0b6c72c

1 similar comment
@jmccaffrey-nv

Copy link
Copy Markdown
Collaborator

/ok to test 0b6c72c

@jmccaffrey-nv jmccaffrey-nv 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.

lgtm

Comment thread docs/source/documentation/inferencing_api/api_reference/pipeline.md
Comment thread pyproject.toml
@ArielG-NV

Copy link
Copy Markdown
Collaborator Author

/ok to test b57dfbf

Comment thread docs/source/documentation/inferencing_api/guides/create_model.md
@ArielG-NV

Copy link
Copy Markdown
Collaborator Author

/ok to test 0ba8eb9

assert "flashdreams.runner_configs" not in manifest["project"]["entry-points"]
assert "RUNNER_" not in config.read_text()


Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 Existing demos lose packaging checks

Deleting test_model_owns_v2_t2v_adapter removes checks that six model packages declare their T2V dependency, include their implementation package, and register the right launch names. Future packaging mistakes could pass CPU checks while leaving a demo unavailable from the command line.

The added Wan adapter makes the old exact-match check too strict. Allow additional launch names while keeping the other checks instead of removing the whole test.

Knowledge Base Used: Standalone text-to-video application

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@ArielG-NV

Copy link
Copy Markdown
Collaborator Author

/ok to test 45cbf7a

@ArielG-NV
ArielG-NV enabled auto-merge October 19, 2026 23:57
@ArielG-NV
ArielG-NV added this pull request to the merge queue Oct 20, 2026
Merged via the queue into NVIDIA:main with commit 98e0d76 Oct 20, 2026
6 checks passed
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.

[Usability] Clean-up/Read-through all documentation and migrate all docs/source to .md

2 participants