documentation-management

Update canonical documentation sources and verify indexing and frontmatter conventions.

18|1|Updated Jan 3, 2026
One-click install
npx skills add https://github.com/nexus-substrate/nexus-agents --skill documentation-management-nexus-substrate
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-management
Source: https://github.com/nexus-substrate/nexus-agents/tree/main/skills/documentation-management
Command: npx skills add https://github.com/nexus-substrate/nexus-agents --skill documentation-management-nexus-substrate

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Documentation-management prevents doc drift by guiding you to update the correct canonical sources, maintain required indexes/frontmatter, and fix pipeline issues so the repository stays discoverable and consistent.

Core Features & Use Cases

  • Canonical-source updates with governance checks: Ensures doc changes flow through the documented sources of truth (like docs/README.md and docs/INDEX.yaml) rather than ad-hoc edits, reducing inconsistency across generated artifacts.
  • DocOps pipeline troubleshooting: Helps when the documentation pipeline is failing or out of date, including verifying indexing and regenerating repo/document indexes.
  • Change verification for pipeline health: Provides a focused verification path to catch broken wiring (indexing, governance injections, and drift) before you merge.

Quick Start

Ask the AI to update the documentation pipeline for your change, then run the doc indexing and governance validation steps to confirm everything is wired correctly.

Frequently Asked Questions about documentation-management

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I fix documentation drift when generated docs checks fail?

Fix documentation drift by updating canonical doc sources, enforcing YAML frontmatter conventions, and validating repository indexing to ensure governance-generated outputs stay consistent. Run doc indexing and governance validation steps to repair the pipeline.

What's the best way to add new documentation while maintaining repository indexing?

Add new documentation by requiring YAML frontmatter for new docs, registering entries in docs/README.md, and validating pipeline integrity with repository indexing, governance injection checks, and doc index verification to keep everything discoverable.

Why does my documentation pipeline fail after changing canonical doc sources?

Documentation pipeline failures occur when changes bypass canonical sources like docs/README.md and docs/INDEX.yaml, causing ad-hoc edits and broken indexing wiring that require governance injection checks and repository indexing validation to resolve.

Do I need YAML frontmatter to update the documentation index?

Yes, YAML frontmatter is required for new docs to update the documentation index correctly. Registering entries in docs/README.md and validating pipeline integrity ensures doc index verification and governance consistency.

Can I use pipeline troubleshooting to regenerate stale output tables in documentation?

Yes, pipeline troubleshooting regenerates stale output tables by verifying indexing and repairing doc drift. Update canonical doc sources and run governance validation to ensure generated artifacts remain consistent and current.

What is DocOps governance injection and when do I need it for documentation changes?

DocOps governance injection ensures doc changes flow through documented sources of truth rather than ad-hoc edits, maintaining consistency across generated artifacts. You need it when adding new docs, changing the doc pipeline, or troubleshooting indexing drift.