agentleFS
aymericzipaymericzip/intlayer/docs/CLAUDE.md

intlayer

CLAUDE.md863 starsChanged 13 days agoApache-2.0View on GitHub

Doc are multilingual. If not explicitly mentioned, never use AI generation for translations using the scripts translate or review + MODE = 'apply'. Those will consume extra token no included in the plan. But you can use review + MODE = 'synthesis' | 'synthesis' to validate the doc consistency. If not mentioned, you should iterate doc by doc and translate manually each doc for each locale without using script.

The file

Show its rules and text

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈10

    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
  1. Very specific:

    Should focus on final user point of view.

    line 3
  2. Distinctive:

    Should looks human written, keep everything concise as possible

    line 8
  3. Distinctive:

    Should avoid commercial positioning

    line 9
  4. Distinctive:

    Keep everything concise as possible

    line 14
  5. Distinctive:

    Don't use '—' char, replace it by ',' to '.'

    line 15
  6. Distinctive:

    All title, description and h1 should be studied for best SEO indexation

    line 17
  7. Very specific:

    Always update updatedAt in front-matter after update

    line 18
  8. Distinctive:

    Add <TOC> for long posts

    line 19
  9. Distinctive:

    Avoid '---' to separate sections

    line 22
  10. Distinctive:

    Add links to other benchmarks docs and links to other docs, compat adapters etc where possible

    line 23
  11. Distinctive:

    Avoid distraction. Go straight to the point.

    line 25
  12. Very specific:

    If not explicitly mentioned, never use AI generation for translations using the scripts translate or review + MODE = 'apply'.

    line 56
  13. Distinctive:

    If not mentioned, you should iterate doc by doc and translate manually each doc for each locale without using script.

    line 57

≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.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
CLAUDE.md

For docs:

  • Should focus on final user point of view. Avoid mention of internal intlayer subtleties
  • To add docs in website navbar, list it in apps/website/src/components/DocPage/docData.content.ts

For blogs:

  • Should looks human written, keep everything concise as possible
  • Should avoid commercial positioning
  • For blogs, list it in apps/website/src/components/BlogPage/blogData.content.ts

For both:

  • Keep everything concise as possible
  • Don't use '—' char, replace it by ',' to '.'
  • Reuse the front-matter format to seo and website indexation.
  • All title, description and h1 should be studied for best SEO indexation
  • Always update updatedAt in front-matter after update
  • Add <TOC> for long posts
  • <Tabs>, <Step>, <Accordion>, <FAQ> where pertinent
  • Links between docs should be like (https://github.com/aymericzip/intlayer/blob/main/docs/.../.md, no ./.../.md, no https://intlayer.org/...)
  • Avoid '---' to separate sections
  • Add links to other benchmarks docs and links to other docs, compat adapters etc where possible
  • For translations check docs/tools/prompts/CUSTOM_INSTRUCTIONS.md
  • Avoid distraction. Go straight to the point. Avoid long blog. Don't hesitate to remove part that are not relevant, duplicated, obsolete, or too verbose for the user

Doc are multilingual.

  • ENGLISH
  • SPANISH
  • RUSSIAN
  • JAPANESE
  • FRENCH
  • KOREAN
  • CHINESE
  • GERMAN
  • ARABIC
  • ITALIAN
  • ENGLISH_UNITED_KINGDOM
  • PORTUGUESE
  • HINDI
  • TURKISH
  • POLISH
  • INDONESIAN
  • VIETNAMESE
  • UKRAINIAN
  • HEBREW_ISRAEL

Structure:

  • docs/docs/{locale}/**/*.md
  • docs/blog/{locale}/**/*.md
  • docs/frequent_questions/{locale}/**/*.md
  • docs/legal/{locale}/**/*.md

If not explicitly mentioned, never use AI generation for translations using the scripts translate or review + MODE = 'apply'. Those will consume extra token no included in the plan. But you can use review + MODE = 'synthesis' | 'synthesis' to validate the doc consistency. If not mentioned, you should iterate doc by doc and translate manually each doc for each locale without using script.

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.