agentleFS
gufo-orggufo-org/gufo/docs/AGENTS.md

gufo

AGENTS.md1.1k starsChanged 8 days agoMITView on GitHub

These rules apply to everything under docs/. They keep the documentation short, consistent and readable by people and agents alike. A public page explains how to use something. An internal page explains how it is built, measured or changed. When a page needs both, split it: the public page links to the internal one. Every public page starts with a # Title line, a blank line and a one- or two-sentence summary; the website uses both for the page title…

Trending

More talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 0 mentionsMar 2026: 0 mentionsApr 2026: 0 mentionsMay 2026: 0 mentionsJun 2026: 0 mentionsJul 2026: 0 mentionsAug 2026: 0 mentionsSep 2026: 0 mentionsOct 2026: 13 mentionsNov 2026: 2 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the gufo-org/gufo repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about gufo-org/gufo

The biggest 5 of 15 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 15

Talked about on GitHub and Bluesky (15 times).

On GitHub · 14

9 more on GitHub
  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 32,671 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository3 other files it gives its agents.

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 6

    Very specific

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

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

    Every public page starts with a # Title line, a blank line and a one- or two-sentence summary.

    line 21
  2. Very specific:

    Write like the Gufo blog: plain, direct and exact.

    line 29
  3. Distinctive:

    Prefer plain words to jargon.

    line 32
  4. Distinctive:

    Use tables only to compare things across the same columns.

    line 39
  5. Distinctive:

    Use plain Markdown that renders on GitHub: no MDX, HTML components or scripts.

    line 43
  6. Distinctive:

    Every sentence must earn its place.

    line 48
  7. Very specific:

    Don't list every flag or field.

    line 57
  8. Very specific:

    Run python3 tools/ci/check-docs.py after editing.

    line 70
  9. Distinctive:

    Add a figure only when it shows a structure or flow faster than prose: what sits where, what happens in which order, what is reused.

    line 81
  10. Very specific:

    use fig-head for row labels, fig-title and fig-sub inside boxes, fig-note for annotations, fig-box plus one color class for boxes and …

    line 105
  11. Distinctive:

    leave about 20% spare width around text, because fallback fonts differ in width from the website fonts.

    line 113
  12. Very specific:

    Keep color meaning consistent within a page: one color per kind of thing, and fig-muted for anything reused, inactive or out of scope.

    line 116

≈ “Common” is an estimate: at least 1 in 5 of the 41,581 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

Documentation

These rules apply to everything under docs/. They keep the documentation short, consistent and readable by people and agents alike.

Layout

PathAudiencePublished
docs/*.md, docs/models/*.mdPeople using or extending GufoWebsite, one copy per release
docs/figures/Figures for public pagesWebsite, with the pages
docs/internal/Contributors and agents working on GufoRepository only
docs/internal/models/<model>/Implementation notes (README.md), benchmarks, quality and experiment evidenceRepository only
docs/internal/server.md, docs/internal/cache.mdComplete server and cache references behind the public pagesRepository only
docs/internal/design/Design RFCsRepository only

A public page explains how to use something. An internal page explains how it is built, measured or changed. When a page needs both, split it: the public page links to the internal one.

Every public page starts with a # Title line, a blank line and a one- or two-sentence summary; the website uses both for the page title and description. README.md is the documentation home: it lists every public page in reading order, and the website builds its navigation from it. Model pages are listed in models/README.md instead.

Style

Write like the Gufo blog: plain, direct and exact.

  • Address the reader as "you". Use the active voice. Contractions are fine.
  • Prefer plain words to jargon. When a term is needed, put it in bold and define it the first time it appears on the page. Use one name for one concept across all pages.
  • Lead with what the reader does or gets; follow with why only when the reader needs it to decide something.
  • Give numbers exactly, with units, and date measurements: "As of November 2026, ...". Link the evidence under docs/internal/ instead of repeating it.
  • Use tables only to compare things across the same columns. Use a numbered list only when order matters.
  • Mark warnings (trust, exposure, data loss) with a blockquote starting with **Warning:**.
  • Use plain Markdown that renders on GitHub: no MDX, HTML components or scripts. Code blocks name their language.

Concision

Every sentence must earn its place; a reader should find the answer without reading the whole page.

  • One topic per page. One fact lives in one place; elsewhere, link to it.
  • Budgets: 250 lines for a public page, 120 for a model page. Over budget means split the page or move detail to docs/internal/.
  • Public pages hold current behavior only: no history ("used to", "now", "recently"), no PR or issue numbers, no design rationale. Rationale belongs in docs/internal/design/.
  • Don't list every flag or field; show the ones a reader needs and point to gufo <command> --help for the rest.
  • Cut filler: "simply", "just", "easily", "basically", "obviously", "note that", "it is worth", "seamless", "blazing".

Keeping docs current

  • A change in user-visible behavior updates the page that owns it in the same pull request.
  • A new public page needs a maintainer's agreement; prefer extending an existing page.
  • Evidence files (JSON, logs, archives, charts) live only under docs/internal/.
  • Run python3 tools/ci/check-docs.py after editing. It enforces the title and summary, the index listing, line budgets, filler words, issue numbers on public pages and the figure rules below.

Figures

Figures are static SVG files in docs/figures/, named after what they show (cache-reuse.svg). They render as images on GitHub and are inlined on the website, where they pick up its fonts. Copy figures/cache-reuse.svg as a starting point.

Add a figure only when it shows a structure or flow faster than prose: what sits where, what happens in which order, what is reused. The prose must still say everything the figure says, because agents read the text, not the picture.

Reference a figure as an image followed by an italic caption line:

![The second request restores the shared prefix and prefills only its new turn.](figures/cache-reuse.svg)

*Figure 1. A repeated prefix is restored, not recomputed.*

The alt text describes what the figure shows in one sentence; the caption states its point.

Each SVG must:

  • set width and height equal to its viewBox size, 760 wide, and draw <rect class="fig-bg" rx="10"> as its first shape so it reads on both light and dark GitHub themes;
  • embed figures/style.css verbatim in its <style> element and use only its classes: no inline colors, fonts or style attributes;
  • use fig-head for row labels, fig-title and fig-sub inside boxes, fig-note for annotations, fig-box plus one color class for boxes and fig-flow/fig-dash with fig-arrowhead markers for arrows;
  • carry role="img" and a <title> matching the alt text;
  • prefix every id with the file name (cache-reuse-arrow), because the website inlines several figures into one page;
  • contain no <script>, <foreignObject>, <image>, external href or web fonts, and stay under 30 KB;
  • leave about 20% spare width around text, because fallback fonts differ in width from the website fonts.

Keep color meaning consistent within a page: one color per kind of thing, and fig-muted for anything reused, inactive or out of scope.

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.