agentleFS
Sign inStart free
openclawopenclaw/docs/AGENTS.md

docs

AGENTS.md76 starsChanged 27 days agoMITView on GitHub

Website UI, translations, and publishing for docs.openclaw.ai. English content and navigation source: openclaw/openclaw. Use --max-priority P3 with the shared autoreview helper to preserve this repository's existing P0–P3 review gate. Follow the shared skill setup before running it.

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Very specific:

    Do not hand-edit generated docs output.

    line 7
  2. Very specific:

    If translated MDX fails, the repair step may touch only docs/<locale>/ and docs/.i18n/<locale>.tm.jsonl.

    line 47
  3. Very specific:

    Use --max-priority P3 with the shared autoreview helper to preserve this repository's existing P0–P3 review gate.

    line 51

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

AGENTS.MD

Website UI, translations, and publishing for docs.openclaw.ai. English content and navigation source: openclaw/openclaw.

Rule

  • Do not hand-edit generated docs output.
  • Fix source or workflow; let sync/translation regenerate.
  • Emergency generated-output edits need explicit owner approval and a follow-up source/workflow fix.

Editable Here

  • scripts/docs-site/** for the website renderer, design, search, and preview tooling.
  • workers/** and wrangler.toml for hosting and compatibility redirects.
  • package.json, package-lock.json, Makefile, and .github/workflows/{pages,r2-pages,docs-code-ci,docs-live-smoke}.yml for website builds, checks, and publishing.
  • AGENTS.md, README.md.
  • CLOUDFLARE.md for repo-owned hosting and deployment guidance.
  • .agents/skills/autoreview/SKILL.md for the shared review skill entrypoint.
  • .github/pull_request_template.md for repo-owned contribution guidance.
  • .github/assets/** for repo-owned README media that must not be pruned by docs sync.
  • .github/workflows/translate-*.yml.
  • .github/workflows/translate-locale-reusable.yml.
  • .github/scripts/i18n/** when maintaining translation workflow control-plane scripts and tests.
  • docs/.i18n/translation-workflow.md when documenting translation workflow internals.
  • docs/.i18n/glossary.<locale>.json when adding fixed glossary terms for the translation workflow.

Do Not Edit Here

  • English docs under docs/**; edit openclaw/openclaw/docs/** instead.
  • docs/docs.json; generated by source sync.
  • Locale pages under docs/<locale>/**; generated by translation workflows.
  • Translation memory docs/.i18n/*.tm.jsonl; generated by translation workflows.
  • Locale navigation files docs/.i18n/*-navigation.json; generated workflow state.
  • .openclaw-sync/source.json; generated sync metadata.
  • .openclaw-sync/check-docs-mdx.mjs and .openclaw-sync/docs-mdx-repair.md; copied from openclaw/openclaw.

Workflow

  • For OpenClaw and OpenClaw Foundation logos, see the brand kit.
  • For a local page preview, run npm run docs:build:preview -- --page <route> (repeat --page for more pages). It builds at most 30 pages in English, including the requested pages. Use this for screenshots; do not run translation or full publishing builds just for a preview. See scripts/docs-site/AGENTS.md for fixture and validation options.
  • Source sync starts in openclaw/openclaw/.github/workflows/docs-sync-publish.yml.
  • Sync mirrors openclaw/openclaw/docs/** into this repo and updates .openclaw-sync/source.json.
  • translate-incremental.yml runs normal debounced docs changes.
  • translate-all.yml reconciles missing or changed translations weekly or by manual dispatch. Matching-page retranslation requires explicit force_retranslate recovery.
  • Translation pending logic compares source file SHA-256 with each page's x-i18n.source_hash.
  • Locale workers upload artifacts; the shared finalizer pushes one aggregate i18n commit.
  • If translated MDX fails, the repair step may touch only docs/<locale>/** and docs/.i18n/<locale>.tm.jsonl.

Autoreview priority

Use --max-priority P3 with the shared autoreview helper to preserve this repository's existing P0–P3 review gate. Follow the shared skill setup before running it.

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