maister / site-docs
AGENTS.md10 starsChanged 6 months agoMITView on GitHub
The files under site-docs/ are the public product documentation. They are not generated from, mirrored from, or interchangeable with the engineering notes under /docs. Write for MAIster users, instance operators, integrators, and AI agents helping those people. Do not publish internal milestones, implementation statuses, ADR discussion, database internals, or repository-maintainer procedures unless they are part of a supported public contract. - Store every page as Markdown with title and description frontmatter. - Keep headings descriptive and unique. - Put one…
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 31,774 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 repository59 other files it gives its agents.
- AGENTS.mdAGENTS.md
- web/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- docs/CLAUDE.mdCLAUDE.md
- web/CLAUDE.mdCLAUDE.md
- aif-architectureSkill
- aif-best-practicesSkill
- aif-build-automationSkill
- aif-ciSkill
- aif-commitSkill
- aif-distillationSkill
- aif-dockerizeSkill
- aif-docsSkill
- aif-evolveSkill
- aif-exploreSkill
- aif-fixSkill
- aif-groundedSkill
- aif-implementSkill
- aif-improveSkill
- aif-loopSkill
- aif-planSkill
- aif-qaSkill
- aif-referenceSkill
- aif-reviewSkill
- aif-roadmapSkill
- aif-rules-checkSkill
- aif-rulesSkill
- aif-security-checklistSkill
- aif-skill-generatorSkill
- aifSkill
- aif-verifySkill
- generate-claudemdSkill
- aif-architectureSkill
- aif-best-practicesSkill
- aif-build-automationSkill
- aif-ciSkill
- aif-commitSkill
- aif-distillationSkill
- aif-dockerizeSkill
- aif-docsSkill
- aif-evolveSkill
- aif-exploreSkill
- aif-fixSkill
- aif-groundedSkill
- aif-implementSkill
- aif-improveSkill
- aif-loopSkill
- aif-planSkill
- aif-qaSkill
- aif-referenceSkill
- aif-reviewSkill
- aif-roadmapSkill
- aif-rules-checkSkill
- aif-rulesSkill
- aif-security-checklistSkill
- aif-skill-generatorSkill
- aifSkill
- aif-verifySkill
- generate-claudemdSkill
The file
We split this AGENTS.md into the rules it gives an agent
6 rules. About 1 is common, 3 are distinctive, and 2 are very specific to this project.
≈1
Common · estimate
Many files like this have a rule of this kind.
≈3
Distinctive · estimate
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
- Very specific: line 9
Write for MAIster users, instance operators, integrators, and AI agents helping those people.
- Distinctive: line 17
Keep headings descriptive and unique.
- Distinctive: line 18
Put one task or concept on one page.
- Distinctive: line 20
Prefer stable product terms: project, Flow package, task, Run, workspace, evidence, human-in-the-loop request, review, and promotion.
- Common: line 24
Never put secrets in examples.
- Very specific: line 29
Run pnpm validate and pnpm links in this package before publishing.
≈ “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.
Files
Public documentation rules
The files under site-docs/ are the public product documentation. They are not
generated from, mirrored from, or interchangeable with the engineering notes
under /docs.
Audience
Write for MAIster users, instance operators, integrators, and AI agents helping those people. Do not publish internal milestones, implementation statuses, ADR discussion, database internals, or repository-maintainer procedures unless they are part of a supported public contract.
Authoring
- Store every page as Markdown with
titleanddescriptionfrontmatter. - Keep headings descriptive and unique.
- Put one task or concept on one page.
- State prerequisites, exact inputs, success criteria, and failure signals.
- Prefer stable product terms: project, Flow package, task, Run, workspace, evidence, human-in-the-loop request, review, and promotion.
- English and Russian pages are separate authored translations. Update both when a public contract changes.
- Never put secrets in examples. Refer to environment variables by name.
- Link to the public documentation, not to internal
/docsfiles.
Verification
Run pnpm validate and pnpm links in this package before publishing. A future
cross-artifact check may compare supported public claims with /docs, but that
check must not turn either artifact into the source of the other.
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
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.

