agentleFS
Sign inStart free
ndthanhdevndthanhdev/aio/skills/repo-docs/SKILL.md

repo-docs

Skill1 starsChanged 18 days agoApache-2.0View on GitHub

Repository documentation management. Use this skill whenever you need to work on the codebase — before making changes, find relevant docs first; after making changes, index new knowledge back into docs.

16 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 13 edited versions we read keep these.

  • 2

    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. Very specific:

    Run the prepare script first.

    line 28
  2. Distinctive:

    When: Before making any codebase change, answering architecture questions, or onboarding to an unfamiliar area.

    line 37
  3. Very specific:

    Start from skills/repo-docs/state/index.md, then drill into the relevant category under docs/.

    line 40
  4. Distinctive:

    When: After a change worth documenting — a new concept, pattern, architecture decision, or workflow.

    line 46

“Common” is measured: kept by at least 6 in 10 of the 13 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

repo-docs

Keeps the repository's documentation in sync with the codebase through two complementary workflows: Find Docs (read before acting) and Index Docs (write after acting).

Docs Structure

Documentation lives in docs/ at the repository root, split into four categories:

FolderPurpose
concepts/Domain concepts, mental models, and terminology
how-it-works/Architecture, internals, data flow, and design decisions
how-tos/Step-by-step guides for common tasks
conventions/Coding standards, naming rules, and patterns to follow

Setup

Run the prepare script first. It creates any missing docs/ folders and ensures a documentation index exists at skills/repo-docs/state/index.md:

node skills/repo-docs/scripts/prepare.mjs

Find Docs

When: Before making any codebase change, answering architecture questions, or onboarding to an unfamiliar area.

Start from skills/repo-docs/state/index.md, then drill into the relevant category under docs/. See references/finding-docs.md for the full procedure.

Index Docs

When: After a change worth documenting — a new concept, pattern, architecture decision, or workflow.

Pick the matching category, prefer updating over duplicating, and update state/index.md to reflect the docs you changed. See references/indexing-docs.md for the full procedure and the doc template.

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