doc-steward

Automate TableRelay documentation lifecycle audits, archiving, API extraction, index rebuilding, and Notion sync.

1|Updated Feb 18, 2026
One-click install
npx skills add https://github.com/s0lci700/OVERLAYS --skill doc-steward
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-steward
Source: https://github.com/s0lci700/OVERLAYS/tree/main/.claude/skills/doc-steward
Command: npx skills add https://github.com/s0lci700/OVERLAYS --skill doc-steward

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Streamlines documentation governance for TableRelay by auditing current docs, cleaning up unused artifacts, extracting API surfaces, rebuilding searchable indexes, and synchronizing summaries with Notion.

Core Features & Use Cases

  • Audit and freshness checks: identify stale or missing docs and surface gaps against Notion and code sources.
  • Archive and housekeeping: move or tag orphaned docs to a done state, keeping the repo tidy.
  • API surface extraction: generate up-to-date API surface documentation from code and Notion sources.
  • Index and sync: rebuild the Docs Index and push summaries to Notion for a human-friendly overview.
  • Sprint alignment: integrate Notion sprint data for alignment between roadmap and docs.

Quick Start

Run /doc-steward all to execute the full documentation lifecycle.

Frequently Asked Questions about doc-steward

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

FAQPage Schema
How do I automate documentation lifecycle management and keep my docs index clean?

Automate documentation lifecycle management by running orchestrated phases for auditing, cleaning, API surface extraction, and index rebuilding to maintain a searchable docs index. This process identifies stale docs, archives orphaned artifacts, and ensures your repository stays tidy.

How does Notion synchronization work for API surface extraction and sprint alignment?

Notion synchronization works by treating Notion as the primary truth source for sprint and roadmap data, pushing human-friendly documentation summaries to it. The extraction process aligns API surfaces and roadmap details by cross-referencing code sources with Notion data.

Can I use YAML frontmatter standards to audit and archive stale docs automatically?

Yes, you can audit and archive stale docs automatically using YAML frontmatter standards. The lifecycle orchestration relies on these frontmatter standards to identify freshness gaps, tag orphaned docs to a done state, and move unused artifacts.

What's the best way to extract an API surface and rebuild a searchable docs index?

The best way to extract an API surface and rebuild a searchable docs index is to execute deterministic phase orchestration across the root and docs/ workspace. This generates up-to-date API documentation from code and syncs summaries for a human-friendly overview.

Do I need to run individual phases or can I execute the full documentation audit at once?

You do not need to run individual phases; you can execute the full documentation audit at once. Running the all phase executes audit, clean, api, sync, and backlog-sync in sequence to handle the complete documentation lifecycle automatically.