Skip to content

docs: Phase 1 content IA — frontmatter, Start here, CLI quickstart#2291

Draft
kheiss-uwzoo wants to merge 1 commit into
NVIDIA:mainfrom
kheiss-uwzoo:docs/content-ia-phase1
Draft

docs: Phase 1 content IA — frontmatter, Start here, CLI quickstart#2291
kheiss-uwzoo wants to merge 1 commit into
NVIDIA:mainfrom
kheiss-uwzoo:docs/content-ia-phase1

Conversation

@kheiss-uwzoo

Copy link
Copy Markdown
Collaborator

Summary

  • Add YAML frontmatter (content_type, audience, journey_stage, prerequisites) to four anchor pages: overview, deployment options, document ingestion workflow, and multimodal extraction.
  • Promote About this section to Start here with a Diataxis-typed onboarding table and durations.
  • Add Documentation on GitHub (external-documentation-map.md) listing canonical NeMo-Retriever GitHub surfaces for Helm, CLI, Docker, and graph customization.
  • Replace the snippet-only CLI quickstart with a self-contained in-repo tutorial (install, ingest, query, next steps).

Internal IA audit and Fern migration plan are not included in this PR.

Test plan

  • mkdocs build -f mkdocs.yml --strict from docs/
  • check-nrl-doc-leakage.ps1 pass
  • git diff upstream/main..HEAD --name-only shows customer docs only (8 files)
  • Manual: Start here to workflow to CLI path readable in built site

Add YAML frontmatter to four anchor pages for agent-readable metadata (content_type, audience, journey_stage, prerequisites). Promote getting started to Start here with a typed onboarding table, add an external documentation map for GitHub-only nav targets, and replace the snippet-only CLI quickstart with a self-contained tutorial.
@kheiss-uwzoo kheiss-uwzoo self-assigned this Jul 1, 2026
@kheiss-uwzoo kheiss-uwzoo added the doc Improvements or additions to documentation label Jul 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant