agentleFS
xmtpxmtp/libxmtp/docs/AGENTS.md

libxmtp

AGENTS.md127 starsChanged 11 days agoMITView on GitHub

Before submitting changes in docs/ or apps/docs/, run from the root: Use current site/reference outputs; never fabricate or copy a build stamp. Report failures and fix broken links. Fixture/dry runs are not full-site passes. For building, matching CI artifacts, native-reference exclusions, and Lychee scope, follow site validation. For spec changes, use the relevant skill linked in specs/README.md.

The file

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

2 rules. About 0 are common, 1 is distinctive, and 1 is 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.

  • 1

    Very specific

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

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

    Before submitting changes in docs/ or apps/docs/, run from the root:

    line 3
  2. Distinctive:

    Use current site/reference outputs.

    line 10

≈ “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

Documentation

Before submitting changes in docs/ or apps/docs/, run from the root:

dev/nix-shell 'just docs check'
dev/nix-shell 'just docs check-external'

Use current site/reference outputs; never fabricate or copy a build stamp. Report failures and fix broken links. Fixture/dry runs are not full-site passes. For building, matching CI artifacts, native-reference exclusions, and Lychee scope, follow site validation. For spec changes, use the relevant skill linked in specs/README.md.

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.