rai-docs-update

Sync module documentation frontmatter with the project's knowledge graph.

71|8|Updated Feb 13, 2026
One-click install
npx skills add https://github.com/humansys/raise --skill rai-docs-update
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: rai-docs-update
Source: https://github.com/humansys/raise/tree/main/packages/raise-cli/src/raise_cli/skills_base/rai-docs-update
Command: npx skills add https://github.com/humansys/raise --skill rai-docs-update

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Detects and repairs drift between repository architecture documentation and the project's knowledge graph so documentation stays accurate and actionable.

Core Features & Use Cases

  • Identify affected modules by building the RaiSE knowledge graph and reading recent diffs to focus comparison scope.
  • Compare module Markdown frontmatter to graph-derived truths for depends_on, depended_by, public_api, and components and produce a drift report.
  • Provide a human-in-the-loop gate to apply only permitted frontmatter updates and optionally scan and propose narrative text fixes before committing changes.
  • Rebuild the graph after changes and present a concise summary to close the coherence loop.

Quick Start

Run the docs update after closing a story to detect and apply frontmatter changes to affected modules.

Frequently Asked Questions about rai-docs-update

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

FAQPage Schema
How do I keep module documentation frontmatter aligned with code changes?▼

To keep module documentation frontmatter aligned with code changes, sync governance/architecture/modules/*.md files against a built knowledge graph to detect and repair drift in dependencies, public APIs, and component counts after story closure.

What is documentation drift in a project knowledge graph?▼

Documentation drift in a project knowledge graph occurs when module Markdown frontmatter fields like depends_on, depended_by, public_api, and components no longer match the actual codebase architecture and recent code diffs.

How to detect architecture documentation drift after modifying code?▼

Detect architecture documentation drift by building the knowledge graph at .raise/rai/memory/index.json, reading recent diffs to identify affected modules, and comparing their frontmatter to graph-derived truths to produce a drift report.

Can I automatically update module docs frontmatter without human approval?▼

Automated frontmatter updates are restricted to allowed fields only and require a human-in-the-loop approval gate for narrative text changes, ensuring safe drift repair while maintaining documentation coherence.

Does updating documentation frontmatter require a pre-built knowledge graph?▼

Updating documentation frontmatter requires a pre-built knowledge graph located at .raise/rai/memory/index.json and module docs stored in governance/architecture/modules/*.md to perform accurate drift comparison and coherence checks.

What is the best way to close the coherence loop after applying documentation updates?▼

The best way to close the coherence loop after applying frontmatter updates is to rebuild the knowledge graph from the updated repository state and present a concise summary of the applied changes and detected drift repairs.