agentleFS
Sign inStart free
QVerisAIQVerisAI/QVerisBot/docs/AGENTS.md

QVerisBot

AGENTS.md184 starsChanged 7 months agoMITView on GitHub

This directory owns docs authoring, Mintlify link rules, and docs i18n policy.

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

4 rules. About 0 are common, 2 are distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    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
  1. Distinctive:

    Keep bundled plugin naming consistent with the repo-wide plugin terminology rules in the root AGENTS.md.

    line 17
  2. Very specific:

    Do not add or edit localized docs under docs/<locale>/ here.

    line 22
  3. Distinctive:

    Treat English docs in this repo plus glossary files as the source of truth.

    line 23
  4. Very specific:

    Before rerunning scripts/docs-i18n, add glossary entries for any new technical terms, page titles, or short nav labels that must stay in …

    line 25

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

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

Docs Guide

This directory owns docs authoring, Mintlify link rules, and docs i18n policy.

Mintlify Rules

  • Docs are hosted on Mintlify (https://docs.openclaw.ai).
  • Internal doc links in docs/**/*.md must stay root-relative with no .md or .mdx suffix (example: [Config](/configuration)).
  • Section cross-references should use anchors on root-relative paths (example: [Hooks](/configuration#hooks)).
  • Doc headings should avoid em dashes and apostrophes because Mintlify anchor generation is brittle there.
  • README and other GitHub-rendered docs should keep absolute docs URLs so links work outside Mintlify.
  • Docs content must stay generic: no personal device names, hostnames, or local paths; use placeholders like user@gateway-host.

Docs Content Rules

  • For docs, UI copy, and picker lists, order services/providers alphabetically unless the section is explicitly describing runtime order or auto-detection order.
  • Keep bundled plugin naming consistent with the repo-wide plugin terminology rules in the root AGENTS.md.

Docs i18n

  • Foreign-language docs are not maintained in this repo. The generated publish output lives in the separate openclaw/docs repo (often cloned locally as ../openclaw-docs).
  • Do not add or edit localized docs under docs/<locale>/** here.
  • Treat English docs in this repo plus glossary files as the source of truth.
  • Pipeline: update English docs here, update docs/.i18n/glossary.<locale>.json as needed, then let the publish-repo sync and scripts/docs-i18n run in openclaw/docs.
  • Before rerunning scripts/docs-i18n, add glossary entries for any new technical terms, page titles, or short nav labels that must stay in English or use a fixed translation.
  • pnpm docs:check-i18n-glossary is the guard for changed English doc titles and short internal doc labels.
  • Translation memory lives in generated docs/.i18n/*.tm.jsonl files in the publish repo.
  • See docs/.i18n/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.

Check your setup, free