docs(extraction): add YAML frontmatter to remaining published pages#2332
Draft
kheiss-uwzoo wants to merge 1 commit into
Draft
docs(extraction): add YAML frontmatter to remaining published pages#2332kheiss-uwzoo wants to merge 1 commit into
kheiss-uwzoo wants to merge 1 commit into
Conversation
Roll out machine-readable metadata (Chapter 4, content IA audit) to the 17 published extraction pages not already covered by NVIDIA#2291. Uses the same frontmatter schema as Phase 1 IA prep: title, content_type, audience, journey_stage, product, features, technologies, prerequisites, duration_minutes (where applicable), surface, and status. Prose and navigation unchanged. Strict mkdocs build passes.
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
1 participant
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.
Summary
Adds YAML frontmatter to the remaining published extraction pages per the content IA audit (Chapter 4 — Metadata & Frontmatter). This is PR3 in the audit-driven docs series, following #2330 (orphans) and #2331 (naming).
Coordinates with #2291: Phase 1 IA already adds frontmatter to six entry-path pages (
overview,getting-started-about,deployment-options,workflow-document-ingestion,multimodal-extraction, plusexternal-documentation-mapandretriever-cli-quickstart). This PR covers the other 17 nav-published pages so the full extraction corpus has metadata once both land.Changes
Adds a YAML frontmatter block to each file (no body prose or nav changes):
concepts.md,releasenotes.md,prerequisites-support-matrix.md,api-keys.mdaudio-video.md,embedding.md,vdbs.md,ray-logging.mdcustomize-extend.md,starter-kits.md,evaluate-on-your-data.mdnemo-retriever-api-reference.md,environment-config.md,content-metadata.mdtroubleshoot.md,faq.md,contributing.mdSchema matches #2291 (
content_type,audience,journey_stage,product,features,technologies,prerequisites, optionalduration_minutes,surface,status).Scope / safety
mkdocs.yml, runtime code, or link-target changes.mkdocs build --strict.Merge note
If #2291 lands first, this PR should rebase cleanly (disjoint file set). If both are open, merge #2291 before #2332 to avoid duplicate frontmatter work on the six overlap pages (there is none by design).
Test plan
mkdocs build --strictsucceeds