agent-skills
AGENTS.md31 starsChanged 6 months agoMITView on GitHub
Format and structure for docs that sync to codagent.dev.
We split this AGENTS.md into the rules it gives an agent
15 rules. About 0 are common, 9 are distinctive, and 6 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈9
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
- Distinctive: line 14
Use one public topic per Markdown file.
- Very specific: line 15
Use lowercase kebab-case filenames, such as quickstart.md or cli-reference.md.
- Distinctive: line 16
Keep repo-facing indexes and the product introduction in README.md.
- Very specific: line 17
Put images under docs/images/ and reference them with relative paths like images/workflow.png.
- Distinctive: line 18
Keep CLAUDE.md as a symlink to AGENTS.md.
- Very specific: line 37
Start the page body with exactly one # heading that matches the page title.
- Very specific: line 38
Use ## headings for the table of contents.
- Very specific: line 39
Use relative links to other docs, such as Quickstart.
- Very specific: line 40
Use fenced code blocks with a language tag, such as bash, yaml, json, or text.
- Distinctive: line 41
Prefer tables for compact reference material and ordered lists for procedures.
- Distinctive: line 42
Do not use raw HTML; the docs site Markdown renderer disables embedded HTML.
- Distinctive: line 46
Write for users of the released tool first, then for contributors.
- Distinctive: line 47
Keep current behavior sourced from code first, then current OpenSpec specs, then docs.
- Distinctive: line 48
Avoid documenting historical or archived behavior as current behavior.
- Distinctive: line 50
When adding a page that should be easy to find, give it frontmatter with the right group and order instead of relying on filename order.
≈ “Common” is an estimate: at least 1 in 5 of the 36,368 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
Documentation Authoring Guide
These instructions apply to Markdown files in this docs/ directory. The docs sync workflow copies these files into the codagent.dev docs site, where the site generator renders them into the product documentation.
File Structure
- Use one public topic per Markdown file.
- Use lowercase kebab-case filenames, such as
quickstart.mdorcli-reference.md. - Keep repo-facing indexes and the product introduction in
README.md; the docs site skipsREADME.md. - Put images under
docs/images/and reference them with relative paths likeimages/workflow.png. - Keep
CLAUDE.mdas a symlink toAGENTS.md; editAGENTS.mddirectly.
Page Metadata
Public docs should start with simple YAML frontmatter:
---
title: Page Title
group: Getting Started
order: 1
description: One sentence summary for previews and metadata.
---Supported groups are Getting Started, Guides, Usage, Configuration, Reference, Operations, Evaluation, and Development. Pages inside a group are sorted by order; use larger numbers for less prominent pages.
Markdown Style
- Start the page body with exactly one
#heading that matches the page title. - Use
##headings for the table of contents; lower headings are fine inside a section. - Use relative links to other docs, such as
[Quickstart](quickstart.md). - Use fenced code blocks with a language tag, such as
bash,yaml,json, ortext. - Prefer tables for compact reference material and ordered lists for procedures.
- Do not use raw HTML; the docs site Markdown renderer disables embedded HTML.
Content Expectations
- Write for users of the released tool first, then for contributors.
- Keep current behavior sourced from code first, then current OpenSpec specs, then docs.
- Avoid documenting historical or archived behavior as current behavior.
- Mention platform or install prerequisites before commands that depend on them.
- When adding a page that should be easy to find, give it frontmatter with the right group and order instead of relying on filename order.
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 28,693 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 repository30 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- releaseSkill
- releaseSkill
- ask-questionsSkill
- call-agentSkill
- designSkill
- finalize-prSkill
- fix-prSkill
- handoffSkill
- implement-changeSkill
- initSkill
- orchestrate-changeSkill
- plan-tasksSkill
- prepare-acceptanceSkill
- proposal-reviewSkill
- proposeSkill
- push-prSkill
- review-approachSkill
- review-assumptionsSkill
- review-specSkill
- review-tasksSkill
- session-reportSkill
- simple-planSkill
- specSkill
- task-complianceSkill
- test-flowsSkill
- test-planSkill
- verify-behaviorSkill
- wait-ciSkill
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.