agentleFS
Sign inStart free
jscraikjscraik/Agent-Skills/Docs/AGENTS.md

Agent-Skills / Docs

AGENTS.md9 starsChanged 46 days agoApache-2.0View on GitHub

- Applies to uppercase Docs/**, the canonical repository guidance and reference-documentation tree. - Inherits the repository root AGENTS.md. Do not use this file as guidance for a lowercase compatibility docs/** tree unless content is explicitly moved there with a documented ownership change. - Before changing workflow, validation, path ownership, skill management, or agent-facing guidance here, prefer the canonical owner under Docs/agents/** unless a narrower Docs/** reference surface is explicitly intended. - Keep any future lowercase docs as compatibility, generated, or…

The file

We split this AGENTS.md into the rules it gives an agent

4 rules. About 0 are common, 1 is distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Before changing workflow, validation, path ownership, skill management, or agent-facing guidance here, prefer the canonical owner under …

    line 17
  2. Distinctive:

    Keep any future lowercase docs as compatibility, generated, or intentionally retained documentation only when a reader or migration reason …

    line 20
  3. Very specific:

    Do not create a competing instruction hierarchy here.

    line 22
  4. Very specific:

    If moving content between docs/ and Docs/, state the source, destination, owner, and reason.

    line 35

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md 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
AGENTS.md

Docs Agent Guide

Scope

  • Applies to uppercase Docs/**, the canonical repository guidance and reference-documentation tree.
  • Inherits the repository root AGENTS.md. Do not use this file as guidance for a lowercase compatibility docs/** tree unless content is explicitly moved there with a documented ownership change.

Edit Policy

  • Before changing workflow, validation, path ownership, skill management, or agent-facing guidance here, prefer the canonical owner under Docs/agents/** unless a narrower Docs/** reference surface is explicitly intended.
  • Keep any future lowercase docs as compatibility, generated, or intentionally retained documentation only when a reader or migration reason is clear.
  • Do not create a competing instruction hierarchy here. If a rule must bind agents, place it in the nearest applicable AGENTS.md or canonical Docs/agents/** file.

Context Pointers

  • Canonical instruction map: Docs/agents/README.md.
  • Lowercase surface policy: Docs/agents/15-repo-surface-ownership.md.
  • Path authority model: Docs/agents/14-path-ownership-boundaries.md.

Validation

  • Validate links after documentation edits.
  • If moving content between docs/** and Docs/**, state the source, destination, owner, and reason; do not silently duplicate guidance.

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