agentleFS
Sign inStart free
lbb00lbb00/ai-rules-sync/.claude/skills/update-docs/SKILL.md

update-docs

Skill37 starsChanged 9 months agoUnlicenseView on GitHub

Update all project documentation after code changes.

87 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use get-pr-reviews, push-everything and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • saffron-healthSkill

    get-pr-reviews

    Get nicely formatted output of the last review comments on a PR. Used internally by other skills.

    Also in 3 projects that use this

  • saffron-healthSkill

    push-everything

    Stage ALL changes in the repository (not just session changes), commit, and push. Use when you need to commit all pending changes.

    Also in 3 projects that use this

  • TheKREATORSSkill

    instinct-export

    Export instincts from project/global scope to a file

    Also in 3 projects that use this

  • TheKREATORSSkill

    instinct-import

    Import instincts from file or URL into project/global scope

    Also in 3 projects that use this

  • NVIDIASkill

    generate-spec

    Produce a feature specification covering API changes, backward compatibility, cross-language impact, performance, and a file-level change plan. Use when designing a new feature, planning a significant change, or the user asks to spec something out.

    Also in 3 projects that use this

  • belokonmSkill

    fullstack-developer

    End-to-end feature expert specializing in frontend-backend integration, system architecture, and complete application development

    Also in 4 projects that use this

  • +1 more from saffron-health
  • +1 more from TheKREATORS

The file

Show its rules and text

We split this skill into the rules it gives an agent

14 rules. 0 are common, 12 are distinctive, and 2 are very specific to this project.

  • 0

    Common

    Most of the 81 edited versions we read keep these.

  • 12

    Distinctive

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Check git status for modified files

    line 15
  2. Very specific:

    Run the update-knowledge-base skill

    line 20
  3. Distinctive:

    Document any architectural or feature changes

    line 21
  4. Distinctive:

    Add new features or commands

    line 24
  5. Distinctive:

    Update examples if API changed

    line 25
  6. Distinctive:

    Ensure accuracy of all documented commands

    line 26
  7. Distinctive:

    Ensure Chinese documentation matches English

    line 30
  8. Very specific:

    Run tests to ensure nothing broken: npm test

    line 33
  9. Distinctive:

    Check that all documented commands work

    line 34
  10. Distinctive:

    After adding a new adapter

    line 39
  11. Distinctive:

    After adding or modifying CLI commands

    line 40
  12. Distinctive:

    After changing the configuration format

    line 41
  13. Distinctive:

    After any user-facing changes

    line 42
  14. Distinctive:

    All documentation files updated and in sync:

    line 46

“Common” is measured: kept by at least 6 in 10 of the 81 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Update Documentation

Instructions

One-click command to update all project documentation after code changes.

Steps

  1. Analyze Changes
    • Check git status for modified files
    • Review recent commits if no uncommitted changes
    • Identify what documentation needs updating
  2. Update KNOWLEDGE_BASE.md
    • Run the update-knowledge-base skill
    • Document any architectural or feature changes
  3. Update README.md
    • Add new features or commands
    • Update examples if API changed
    • Ensure accuracy of all documented commands
  4. Sync README_ZH.md
    • Run the sync-readme skill
    • Ensure Chinese documentation matches English
  5. Verify
    • Run tests to ensure nothing broken: npm test
    • Check that all documented commands work
    • Review diff before committing

When to Use

  • After adding a new adapter
  • After adding or modifying CLI commands
  • After changing the configuration format
  • After any user-facing changes

Output

All documentation files updated and in sync:

  • KNOWLEDGE_BASE.md (if exists)
  • README.md
  • README_ZH.md

Examples

Request: Update all docs after adding OpenCode support Result: KNOWLEDGE_BASE.md, README.md, and README_ZH.md all updated

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free