[docs]: batched docs cleanup (landing page, links, requirements, nav) - #1644
Merged
Conversation
Contributor
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
Contributor
Merge Protections🔴 1 of 1 protections blocking · waiting on 👀 reviews and 🤖 CI
🔴 PR merge requirementsWaiting for
This rule is failing.
|
SolitaryThinker
force-pushed
the
docs_cleanup_batch
branch
from
July 26, 2026 00:44
3aedd52 to
60992b8
Compare
SolitaryThinker
force-pushed
the
docs_cleanup_batch
branch
from
July 26, 2026 11:21
60992b8 to
55c5cee
Compare
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
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.
Batch of nit-class, pure-factual docs fixes (per the batched-PR policy: grouped for one review session; no behavior changes). Each item below is independent; itemized for line-by-line review. Source audit: docs-role first-boot audit vs main @
8d89f30d.Items
docs/index.md) — [audit HIGH-3] Key Features led with Sliding Tile Attention (archived tosta_do_not_delete; the support matrix itself says VSA is strictly better onmain) and omitted VSA/DMD2/QAD/self-forcing/Dreamverse. Rewritten to mirror the README's current feature set with links to each docs page (all 10 link targets verified present); tagline aligned to the README's; unsourced "near linear scaling to 64 GPUs" claim dropped.docs/inference/inference_quick_start.md) — [audit MED-5] Requirements said Linux-only while the repo ships a maintained MPS install guide; now lists macOS/Apple-silicon alongside Linux. (Windows intentionally not added: no install doc backs it.)docs/getting_started/installation.md) — the hub's requirements block never stated a Python range even thoughgpu.mdand the quickstart both document 3.10-3.12. Now states 3.10-3.12 as the tested and recommended range — deliberately not a support ceiling, sincepyproject.tomldeclaresrequires-python = ">=3.10"and the lockfile resolves 3.13+ (maintainer review infra/r37; also corrects this PR's earlier framing of [Bug] Failed to install via pip #1490, whose actual failure wasOSError: Disk quota exceeded, not wheel incompatibility).README.md) — [audit MED-4] the Key Features bullet promised a "full list of supported models and recipes" attraining/overview, which contains no model list; now points at the training workflows there and the support matrix for models.mkdocs.yml) — [audit MED-8] the inference Examples nav listed 3 pages including an archived one, while the LTX-2.3 example pages thatdocs/generate_examples.pyemits were invisible. Added: Examples Index, LTX-2.3, LTX-2.3 Gradio Demo. All six nav targets verified to be produced by a freshgenerate_examples.pyrun.Landed separately
Not in this batch (and why)
Supersedes #1642 (closed).
Test evidence
pre-commit run --files <changed files>: codespell + PyMarkdown pass.generate_examples.pyrun confirms every referenced page is emitted.