-
Notifications
You must be signed in to change notification settings - Fork 409
Closed
Labels
area:docsDocumentation and examplesDocumentation and examplesstate:pr-openedPR has been opened for this issuePR has been opened for this issue
Description
Description
Set up the foundational documentation infrastructure for NemoClaw using Sphinx/MyST with the NVIDIA theme.
Scope
-
docs/conf.py— Sphinx configuration with nvidia-sphinx-theme, MyST parser, sphinx-design, mermaid, copybutton -
docs/index.md— Landing page with toctree structure - Section directories with placeholder index pages:
about/,get-started/,feature1/,feature2/,observability/,references/,troubleshooting/,resources/ -
pyproject.toml—docsdependency group (uv/PEP 735 style) -
Makefile—docs,docs-strict,docs-serve,docs-cleantargets usinguv run -
build/docs.toml— Equivalent mise tasks -
.gitignore—_build/added - GitHub Actions workflows:
docs-build.yaml— Build on PRs to main and pushes, upload artifact, publish to gh-pagesdocs-preview-pr.yaml— PR preview comments via nvidia-merlin shared workflowdocs-remove-stale-reviews.yaml— Weekly stale preview cleanup
Definition of Done
make docs-strictbuilds with zero warningsmake docs-servestarts a live-reload server on port 8001- CI workflows trigger correctly on docs-related PRs
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
area:docsDocumentation and examplesDocumentation and examplesstate:pr-openedPR has been opened for this issuePR has been opened for this issue