keep-docs-en-pt-parity
Skill1 starsChanged 3 days agoMITView on GitHub
Keep docs/en and docs/pt as true mirrors — same files, same structure, EN as the source of truth. Use when: The task adds, renames, removes, or substantially edits any file under docs/.
In this repository29 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/copilot-instructions.mdCopilot instructions
- .cursor/rules/00-doctrina.mdcCursor rule
- add-cli-commandSkill
- check-the-line-ending-before-patchingSkill
- cut-a-releaseSkill
- keep-docs-en-pt-paritySkill
- ledger-abandoned-entries-are-ledger-onlySkill
- read-the-grammar-through-the-document-modelSkill
- split-an-oversized-specSkill
- stage-a-change-backlogSkill
- triage-holds-work-on-the-machinerySkill
- write-acceptance-evidenceSkill
- add-cli-commandSkill
- check-the-line-ending-before-patchingSkill
- cut-a-releaseSkill
- ledger-abandoned-entries-are-ledger-onlySkill
- read-the-grammar-through-the-document-modelSkill
- split-an-oversized-specSkill
- stage-a-change-backlogSkill
- triage-holds-work-on-the-machinerySkill
- write-acceptance-evidenceSkill
- doctrina-contextSkill
- doctrina-nextSkill
- doctrina-onboardSkill
- doctrina-statusSkill
- doctrina-whySkill
- doctrina-workSkill
The file
We split this skill into the rules it gives an agent
3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
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
- Very specific: line 20
Never translate file paths, command names, code identifiers, fenced examples, or artifact status vocabulary (active, verified, Read-only).
- Distinctive: line 25
Every PT file carries, right under its H1, the source note:
- Very specific: line 33
Check yourself with the gates: doctrina validate warns on a missing EN↔PT counterpart, and node scripts/check-docs.js (also wired into …
≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill 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
<!-- doctrina:skill-export — generated from .doctrina/skills/keep-docs-en-pt-parity.md by `doctrina index rebuild`; edit that file, not this one. -->Skill — keep-docs-en-pt-parity
When to use this skill
- Adding a new documentation topic.
- Editing an EN doc (the PT mirror must move in the same change).
- Renaming or deleting a doc file.
Procedure
- EN is the source of truth; PT is a translation of EN, never the
reverse. Author the EN change first, then mirror it into the PT
file with the identical filename under
docs/pt/. - Never translate file paths, command names, code identifiers,
fenced examples, or artifact status vocabulary (
active,verified,Read-only). Headings that name commands stay in backticks exactly as in EN (## doctrina spec set <capability>stays untranslated) — the docs drift test parses them. - Every PT file carries, right under its H1, the source note:
Tradução da versão em inglês. O inglês é a fonte de verdade; este arquivo o segue.
- A new topic lands as a PAIR (EN + PT) in the same change, plus a
sidebar entry in
docs/en/_sidebar.mdanddocs/pt/_sidebar.md. - Prose docs stay under the 250-line soft cap
(
.doctrina/specs/docs/spec.md); lookup references (cli-reference.md) are exempt — agents read them per-section. - Check yourself with the gates:
doctrina validatewarns on a missing EN↔PT counterpart, andnode scripts/check-docs.js(also wired intodoctrina verify) checks parity, H1 shape, line caps, and the PT source note. - The gates check SHAPE, not content: a PT bullet can say the
opposite of its EN twin with the same line count. For an audit,
compare per file what does not translate — the inline code spans
(commands, flags, paths; placeholders such as
<name>/<nome>normalised), the numbers, the link targets — and read every pair that differs. That is how "constitution deferred" (PT) against "shipped in 0.10.0" (EN), a table row that said a vague word for "8 personas", and an EN-only fact (cwdper verify check) were found in change 0228. - The PT source note costs three lines, so a PT file runs into the
250-line cap before its EN twin. Rewrap the PT paragraphs that
break short instead of cutting content, and diff the WORDS before
and after (
git show HEAD:<file>split on whitespace) to prove the rewrap changed none. - A doc that walks a flow is checked by walking it: run its commands
in order in a temporary directory, and keep the walk as a test when
the flow matters (
test/o-guia-de-ponta-a-ponta-roda-como-escrito.test.js). A Mermaid block is checked by rendering it (mermaid.renderin a headless browser against the versiondocs/index.htmlloads) — counting node ids proves nothing about whether it parses.
Anti-patterns
- "I'll translate it later": the file lands in EN only, the PT tree silently falls behind, and no reader of the PT docs ever learns the feature exists.
- Translating a command heading (
## doctrina search <termo>is fine in the body text, but the command word itself must remainsearch) — it breaks lookup and the heading-based drift test. - Writing new content directly in PT. If the content is worth having, it is worth having in the source language first.
Related material
.doctrina/specs/docs/spec.md— the docs capability contract.scripts/check-docs.js— the executable shape check.AGENTS.md— "Do NOT translate file paths, command names, or code identifiers."
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.

