agentleFS
rcdelfinrcdelfin/agentkit/skills/planning/dox/SKILL.md

dox

Skill2 starsChanged 3 months agoMITView on GitHub

Self-documenting AGENTS.md hierarchy for AI agents. Root contains project-wide rules and child index; child AGENTS.md files in subdirectories define local contracts. Agent walks the full path from root to target before any edit, updates affected files after. No installation needed — just Markdown instructions. From agent0ai/dox. Load when: initializing project context, creating AGENTS.md files, encountering a DOX hierarchy, or when Rule 4/6 of global behavioral guidelines references DOX pattern.

1 other project uses a version of this, 1 of them edited.

Adopted by

Most recently taken up by

The file

Show its rules and text

We split this skill into the rules it gives an agent

20 rules. About 0 are common, 20 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈20

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Read the root AGENTS.md

    line 27
  2. Distinctive:

    Read every AGENTS.md found along each route

    line 30
  3. Distinctive:

    If a parent AGENTS.md lists a child AGENTS.md whose scope contains the path, read that child and continue from there

    line 31
  4. Distinctive:

    Use the nearest AGENTS.md as the local contract and parent docs for repo-wide rules

    line 32
  5. Distinctive:

    If docs conflict, the closer doc controls local work details, but no child doc may weaken DOX

    line 33
  6. Distinctive:

    Do not rely on memory. Re-read the applicable DOX chain in the current session before editing.

    line 35
  7. Distinctive:

    Every meaningful change requires a DOX pass before the task is done.

    line 39
  8. Distinctive:

    Update the closest owning AGENTS.md when a change affects:

    line 41
  9. Distinctive:

    Create a child AGENTS.md when a folder becomes a durable boundary with its own purpose, rules, responsibilities, workflow, materials, or …

    line 60
  10. Distinctive:

    Keep docs concise, current, and operational

    line 75
  11. Distinctive:

    Document stable contracts, not diary entries

    line 76
  12. Distinctive:

    Put broad rules in parent docs and concrete details in child docs

    line 77
  13. Distinctive:

    Prefer direct bullets with explicit names

    line 78
  14. Distinctive:

    Do not duplicate rules across many files unless each scope needs a local version

    line 79
  15. Distinctive:

    Delete stale notes instead of explaining history

    line 80
  16. Distinctive:

    Update nearest owning docs and any affected parents or children

    line 86
  17. Distinctive:

    Remove stale or contradictory text

    line 88
  18. Distinctive:

    Run existing verification when relevant

    line 89
  19. Distinctive:

    When the user requests a durable behavior change, record it here or in the relevant child AGENTS.md

    line 94
  20. Distinctive:

    No child AGENTS.md files are needed for the current repository structure.

    line 98

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “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

DOX framework

  • DOX is highly performant AGENTS.md hierarchy installed here
  • Agent must follow DOX instructions across any edits

Core Contract

  • AGENTS.md files are binding work contracts for their subtrees
  • Work products, source materials, instructions, records, assets, and durable docs must stay understandable from the nearest applicable AGENTS.md plus every parent AGENTS.md above it

Read Before Editing

  1. Read the root AGENTS.md
  2. Identify every file or folder you expect to touch
  3. Walk from the repository root to each target path
  4. Read every AGENTS.md found along each route
  5. If a parent AGENTS.md lists a child AGENTS.md whose scope contains the path, read that child and continue from there
  6. Use the nearest AGENTS.md as the local contract and parent docs for repo-wide rules
  7. If docs conflict, the closer doc controls local work details, but no child doc may weaken DOX

Do not rely on memory. Re-read the applicable DOX chain in the current session before editing.

Update After Editing

Every meaningful change requires a DOX pass before the task is done.

Update the closest owning AGENTS.md when a change affects:

  • purpose, scope, ownership, or responsibilities
  • durable structure, contracts, workflows, or operating rules
  • required inputs, outputs, permissions, constraints, side effects, or artifacts
  • user preferences about behavior, communication, process, organization, or quality
  • AGENTS.md creation, deletion, move, rename, or index contents

Update parent docs when parent-level structure, ownership, workflow, or child index changes. Update child docs when parent changes alter local rules. Remove stale or contradictory text immediately. Small edits that do not change behavior or contracts may leave docs unchanged, but the DOX pass still must happen.

Hierarchy

  • Root AGENTS.md is the DOX rail: project-wide instructions, global preferences, durable workflow rules, and the top-level Child DOX Index
  • Child AGENTS.md files own domain-specific instructions and their own Child DOX Index
  • Each parent explains what its direct children cover and what stays owned by the parent
  • The closer a doc is to the work, the more specific and practical it must be

Child Doc Shape

  • Create a child AGENTS.md when a folder becomes a durable boundary with its own purpose, rules, responsibilities, workflow, materials, or quality standards
  • Work Guidance must reflect the current standards of the project or user instructions; if there are no specific standards or instructions yet, leave it empty
  • Verification must reflect an existing check; if no verification framework exists yet, leave it empty and update it when one exists

Default section order:

  • Purpose
  • Ownership
  • Local Contracts
  • Work Guidance
  • Verification
  • Child DOX Index

Style

  • Keep docs concise, current, and operational
  • Document stable contracts, not diary entries
  • Put broad rules in parent docs and concrete details in child docs
  • Prefer direct bullets with explicit names
  • Do not duplicate rules across many files unless each scope needs a local version
  • Delete stale notes instead of explaining history
  • Trim obvious statements, repeated rules, misplaced detail, and warnings for risks that no longer exist

Closeout

  1. Re-check changed paths against the DOX chain
  2. Update nearest owning docs and any affected parents or children
  3. Refresh every affected Child DOX Index
  4. Remove stale or contradictory text
  5. Run existing verification when relevant
  6. Report any docs intentionally left unchanged and why

User Preferences

When the user requests a durable behavior change, record it here or in the relevant child AGENTS.md

Child DOX Index

  • No child AGENTS.md files are needed for the current repository structure.
  • Root-owned files: README.md, LICENSE, banner.jpg, video-thumbnail.jpg, and root-level project documentation.

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.