bchanot/claude
1
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(doc-syncer): stack-aware audit with deploy-doc gating

Browse Source 
Auto-discover what the project actually has instead of a fixed doc list:
root files (incl. DEPLOY.md, SECURITY.md, ARCHITECTURE.md, ROADMAP.md),
docs/**, and .claude/{tasks,audits,memory}/.

Detect stack (Node/Python/Rust/Go/Ruby/PHP/Dart/.NET) and deploy
complexity (NONE/TRIVIAL/NON_TRIVIAL) to drive doc-needs:
- Propose DEPLOY.md only when non-trivial (Docker, fly.toml, k8s,
  multi-stage CI).
- Propose inlining/removing DEPLOY.md when deploy is trivial.
- Enforce README presence with typical GitHub layout.

Add CREATE/REMOVE proposal categories to the validation gate. Update
auto-mode to map deploy artifacts to DEPLOY.md and decisions.md
architectural changes back to CLAUDE.md/README.

Sync skills/doc/SKILL.md description + triggers to match.

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
bastien
2026-05-06 17:09:12 +02:00
co-authored by Claude
parent 863fc0b646
commit b2a5b5a602
2 changed files with 302 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skills/doc/SKILL.md
+13 -7
View File
@@ -1,15 +1,21 @@
---
name: doc
description: |
Full documentation audit and sync. Detects stale docs by cross-referencing
git history against README, CLAUDE.md, INSTALL.md, CONFIGURE.md, USAGE.md,
CONTRIBUTING.md, CHANGELOG.md, docs/**/*.md, and inline comments (JSDoc,
docstrings, rustdoc, godoc). Reports drift with commit refs, proposes fixes,
patches approved items. Detects added features missing from docs and removed
features still documented (feature delta detection).
Full documentation audit and sync. Auto-detects what doc files the project
actually has — root docs (README, CLAUDE.md, INSTALL.md, CONFIGURE.md,
USAGE.md, DEPLOY.md, CONTRIBUTING.md, CHANGELOG.md), docs/**/*.md, project-state
files in .claude/{tasks,audits,memory}/, and inline comments (JSDoc, docstrings,
rustdoc, godoc). Stack-aware: detects framework + deploy complexity, proposes
DEPLOY.md only when non-trivial (Docker, fly.toml, k8s, multi-stage CI), skips
for trivial deploys (FTP push, single scp, plain static). Enforces README
presence with typical GitHub layout (title, quick start, links to existing
sub-docs). Cross-references git history for drift; detects added features
missing from docs and removed features still documented (feature delta
detection). Reports drift with commit refs, proposes fixes, patches approved
items.
Trigger: "doc", "sync docs", "audit docs", "update readme", "check documentation",
"are docs up to date", "documentation drift", "stale docs", "new feature not documented",
"removed feature still in docs".
"removed feature still in docs", "create README", "should I have a DEPLOY doc".
Replaces the old /readme skill with broader scope.
argument-hint: [leave empty for full audit, or list specific files/docs to check]
disable-model-invocation: false