docs-sync

Solid

Bring documentation back in line with the code after changes to behavior, paths, versions, or generated output. Use on "update the docs", "refresh the README", "docs are stale", and right before opening a PR that changed any of those. Checks each documented claim against the actual code, command output, or official docs, and updates the parallel-language files together.

Code & Development 25 stars 4 forks Updated 1 weeks ago MIT

Install

View on GitHub

Quality Score: 82/100

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

Skill Content

# Documentation sync (docs-sync) Stale docs pass every automated gate. The link checker only sees broken links; the test suite never reads prose. So this is enforced as a procedure. ## Principles - **Verify claim by claim.** Do not skim for readability. Extract the **checkable claims** a sentence makes — paths, versions, numbers, behavior, defaults — and check each against reality. - **Never edit without evidence.** A `file:line`, a command's output, or an official-docs URL. What you could not confirm gets marked **"unverified"** rather than deleted — deleting it destroys the information. - **No optimistic wording.** If something only partly works, do not write that it "works". State what holds and what does not. ## Procedure ### 1. Extract the change surface ```bash git log --oneline <last-doc-commit>..HEAD git diff --stat <last-doc-commit>..HEAD ``` Keep only what documentation can be wrong about: CLI flags and defaults, paths, generated artifacts, versions, thresholds, gate behavior, support scope. ### 2. Collect the checkable claims Targets: `README*`, `AGENTS.md`, `CLAUDE.md`, per-directory `README.md`, skill/agent docs. ```bash grep -rn '`[^`]*/`\|version\|default\|v[0-9]\+\.[0-9]' README*.md docs/ 2>/dev/null ``` What goes stale fastest: **directory-tree blocks** (new artifacts missing), **version strings**, **"it automatically ..." behavior claims**, **support matrices**. ### 3. Check each claim | Claim type | How to verify | |---|---| | Path / fi...

Details

Author
LeeYudok
Repository
LeeYudok/agents-scaffold
Created
1 months ago
Last Updated
1 weeks ago
Language
Shell
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category