Skip to content

Add enhanced frontmatter to all documentation#425

Merged
lludlow merged 3 commits intomainfrom
feature/enhanced-frontmatter
Apr 9, 2026
Merged

Add enhanced frontmatter to all documentation#425
lludlow merged 3 commits intomainfrom
feature/enhanced-frontmatter

Conversation

@jasnoyaeger
Copy link
Copy Markdown
Member

@jasnoyaeger jasnoyaeger commented Apr 3, 2026

Summary

  • Added rich YAML frontmatter (title, description, semantic_keywords, use_cases, tags, categories) to 292 documentation files across product guides, implementation guides, release notes, and knowledge base articles
  • Created /front-matter skill defining the canonical frontmatter schema for both KB and non-KB docs
  • Deleted placeholder adding-storage.md (empty KB Template)

Breakdown

Area Files Updated
Product Guides 172
Knowledge Base 99 (5 already compliant)
Implementation Guide 12
Release Notes 8
Front-matter skill 1 (new)

KB-specific fixes

  • Added semantic_keywords and use_cases to all 99 non-compliant articles
  • Added missing author: VergeOS Documentation Team to 81 articles
  • Converted publisheddraft on 11 articles
  • Filled 30 empty description fields
  • Fixed bracket-style YAML tags to proper list format
  • Normalized tag casing to lowercase

Test plan

  • Verify mkdocs serve builds without errors
  • Spot-check frontmatter on a few files from each directory
  • Confirm KB blog index renders correctly
  • Verify no body content was modified (only frontmatter changes)

Requested by @lludlow

Closes #424

🤖 Generated with Claude Code

Add rich YAML frontmatter (title, description, semantic_keywords, use_cases,
tags, categories) to 292 documentation files across product guides,
implementation guides, release notes, and knowledge base articles.

- Product guides, implementation guides, release notes: added full frontmatter schema
- KB articles: added semantic_keywords, use_cases, author, fixed published→draft,
  filled empty descriptions, fixed bracket YAML, normalized tag casing
- Deleted placeholder adding-storage.md (KB Template with no content)
- Created /front-matter skill defining the frontmatter schema

Closes #424

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jasnoyaeger jasnoyaeger requested a review from lludlow April 3, 2026 17:24
API-Tables.md and troubleshootingnas.md had `published: false` which MkDocs
ignored (not a recognized field), so pages were live. Converting to `draft: true`
broke the build. Set to `draft: false` to keep them published.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Resolve conflict: accept deletion of nvidia-vgpu.md (replaced by
nvidia-vgpu-configuration.md on main with its own frontmatter).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@lludlow lludlow merged commit b6c2778 into main Apr 9, 2026
2 checks passed
jasnoyaeger added a commit that referenced this pull request Apr 9, 2026
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jasnoyaeger jasnoyaeger deleted the feature/enhanced-frontmatter branch April 9, 2026 16:06
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.

[DOCS UPDATE] Add enhanced frontmatter

2 participants