oma-docs

Solid

Verify documentation references against the current codebase and propose updates for diff-affected docs. Use to check if docs still match reality (broken file paths, CLI commands, config keys, env vars, scripts) and to surface docs that may need updating after code changes.

Data & Documents 1,081 stars 126 forks Updated today MIT

Install

View on GitHub

Quality Score: 93/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# oma-docs - Documentation Drift Detector ## Scheduling ### Goal Detect broken references in `docs/**/*.md` (verify mode) and propose LLM-generated patch proposals for docs affected by recent code changes (sync mode). Both modes run on-demand; sync is always interactive. ### Intent signature - User asks to check if docs are up to date, find broken doc links, verify file paths referenced in docs, or detect documentation drift. - User asks to update docs after a code change, propose doc patches for a git diff, or sync affected docs. - A workflow hook checks `docs.auto_verify: true` and runs `oma docs verify --json` at completion. ### When to use - After a refactor, rename, or file deletion, to find stale references in docs. - Before a release, to confirm that CLI commands, file paths, and config keys in docs still exist. - After a significant git diff, to discover which docs reference the changed files and may need updating. - Routine drift check on any docs-heavy repo. ### When NOT to use - Generating docs from scratch for undocumented features → v2 create mode. - Multilingual translation of docs → use `oma-translator`. - Symbol-level semantic drift (function signature changes not reflected in prose) → v2 L3 mode. - CI-blocking enforcement → v2 block mode (v1 is warn-only). ### Expected inputs **verify mode**: Optional glob path (default `**/*.md`), optional `--json` flag, optional `--report-file <path>`. **sync mode**: Optional git diff range (default `--cached`, fall...

Details

Author
first-fluke
Repository
first-fluke/oh-my-agent
Created
4 months ago
Last Updated
today
Language
TypeScript
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category