agentleFS
Sign inStart free
tessaryaitessaryai/tessary/docs/AGENTS.md

tessary

AGENTS.md20 starsChanged 2 months agoApache-2.0View on GitHub

These instructions apply to all files under /docs. Before writing or editing documentation, read: Read /handbook/brand-foundations.md when describing Tessary, its purpose, or its positioning. The handbook is authoritative. Do not restate its rules in this file. Read mintlify-guide.md (in this folder) before implementing a change: page structure, docs.json, components, and validation. It supplements the handbook and does not replace it. Before finishing: - Verify commands, configuration, defaults, and product behavior. - Confirm that links and referenced interface labels are current.…

  • 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,542 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 repository7 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, 8 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈8

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Before writing or editing documentation, read:

    line 9
  2. Very specific:

    Read /handbook/brand-foundations.md when describing Tessary, its purpose, or its positioning.

    line 16
  3. Very specific:

    Read mintlify-guide.md (in this folder) before implementing a change: page structure, docs.json, components, and validation.

    line 20
  4. Distinctive:

    Read the target page and related documentation.

    line 24
  5. Distinctive:

    Do not invent product behavior, terminology, defaults, or interface labels.

    line 27
  6. Distinctive:

    Ask for clarification when the implementation does not establish the answer.

    line 28
  7. Distinctive:

    Keep changes within the requested scope.

    line 33
  8. Distinctive:

    Do not rewrite unrelated content.

    line 34
  9. Very specific:

    Use terminology defined in /handbook/product-glossary.md.

    line 35
  10. Distinctive:

    Update affected links and related references when necessary.

    line 36
  11. Distinctive:

    Verify commands, configuration, defaults, and product behavior.

    line 43
  12. Very specific:

    Run docs/vale/check.sh and resolve any errors it reports.

    line 46

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

Scope

These instructions apply to all files under /docs.

Required reading

Before writing or editing documentation, read:

  • /handbook/documentation-style-guide.md
  • /handbook/writing-style-guide.md
  • /handbook/voice-and-tone.md
  • /handbook/product-glossary.md

Read /handbook/brand-foundations.md when describing Tessary, its purpose, or its positioning.

The handbook is authoritative. Do not restate its rules in this file.

Read mintlify-guide.md (in this folder) before implementing a change: page structure, docs.json, components, and validation. It supplements the handbook and does not replace it.

Before making changes

  • Read the target page and related documentation.
  • Inspect the relevant code, configuration, and interface.
  • Confirm the intended reader and document type.
  • Do not invent product behavior, terminology, defaults, or interface labels.
  • Ask for clarification when the implementation does not establish the answer.

Editing constraints

  • Preserve the page’s purpose and document type.
  • Keep changes within the requested scope.
  • Do not rewrite unrelated content.
  • Use terminology defined in /handbook/product-glossary.md.
  • Update affected links and related references when necessary.
  • Link to canonical information instead of duplicating it.

Verification

Before finishing:

  • Verify commands, configuration, defaults, and product behavior.
  • Confirm that links and referenced interface labels are current.
  • Review the change against the required handbook guides.
  • Run docs/vale/check.sh and resolve any errors it reports. It only covers a narrow, mechanical subset of the handbook (see docs/vale/README.md); passing it is not a substitute for the review above.
  • Report any assumptions or details that could not be verified.

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