Skip to content

docs(fr): sync translations with upstream and fix sidebar ordering#2231

Open
eatse21 wants to merge 11 commits intobmad-code-org:mainfrom
eatse21:i18n/fr_FR
Open

docs(fr): sync translations with upstream and fix sidebar ordering#2231
eatse21 wants to merge 11 commits intobmad-code-org:mainfrom
eatse21:i18n/fr_FR

Conversation

@eatse21
Copy link
Copy Markdown
Contributor

@eatse21 eatse21 commented Apr 8, 2026

Summary

Update French docs translation from 2302d9c to b744408:

  • Translate new/rewritten pages: checkpoint preview explanation with diagram, get-answers-about-bmad rewrite, bmad-prfaq skill
  • Restore Amelia as dev agent and agent invocation in getting started
  • Remove SM Agent and QA agent references to match upstream
  • Clean up agents.md superfluous frontmatter description details
  • Fix sidebar order numbering (duplicates in explanation/ and reference/) to match existing website order

All commits clearly separated for ease of review, and referencing individual upstream commit changes

Review Notes

  • All docs (including fr) have still references to bmad-[dev/pm/analyst...] instead of bmad-agent-[x] in multiple places -> I preferred matching reference for now for a future global fix all at once
  • Sidebar numbering issue exists in other languages — but not all have translated checkpoint preview or bmad-prfaq yet - I fixed in fr translation for now
  • bmad-agent-analyst Mary has now those triggers (MR, DR, TR), but English and others are still referencing RS
  • Is "Quick Flow" still a thing? I had converted all references to "Quick Dev" previously. If not, it needs update in other languages, or a fix on my side

Since _bmad/__config/agents/ is now an empty folder (#2117), is this section still valid? (how-to/customize-bmad.md)

### 1. Locate Customization Files

After installation, find one `.customize.yaml` file per agent in:

_bmad/_config/agents/
├── core-bmad-master.customize.yaml
├── bmm-dev.customize.yaml
├── bmm-pm.customize.yaml
└── ... (one file per installed agent)

/bmad-editorial-review-translation output:

Translation Fidelity Review

Files reviewed: 29 French vs 29 English sources
Language: French


Findings

INFO (benign translator additions — systematic pattern)

## Glossaire sections + footnote markers (18 files)

A ## Glossaire section with footnote definitions ([^1], [^2], etc.) was added to 18 of 29 files. These define technical terms (PRD, UX, NFR, Sprint, ADR, MVP, etc.) that the English source assumes readers know. Corresponding [^n] markers were also injected into body text. This is a consistent translator-helpfulness pattern, not agenda-driven content.

Localized diagram assets (1 file)

Legitimate locale-specific image/HTML substitutions:

  • explanation/checkpoint-preview.md: .png-fr.webp

Sidebar order drift (13 files)

Most French files have different sidebar.order values than their English counterparts. The FR values are consistently higher, suggesting the FR sidebar was renumbered (possibly to interleave with another section). English source values unchanged — this is a FR-only config choice.

Numbering fix in established-projects.md

EN source has two ## Step 3: headings (a bug). FR correctly renumbers to Etape 3 / Etape 4.


DRIFT (meaning divergence — verify intent)

"Quick Flow" → "Quick Dev" across 5 files

The English source consistently uses "Quick Flow" as the track/method name. The French translation substitutes "Quick Dev" in established-projects-faq, project-context (explanation), why-solutioning-matters, modules, and workflow-map. If the product was renamed, this is correct; if they are distinct concepts, this is an error.

how-to/customize-bmad.md

  • Section: Directory tree example (lines 34-36)
  • Source says: core-bmad-master.customize.yaml, bmm-dev.customize.yaml, bmm-pm.customize.yaml
  • Translation says: bmm-analyst.customize.yaml, bmm-architect.customize.yaml
  • Assessment: Different agent filenames in the example. May reflect a version difference.

reference/agents.md

  • Section: Analyst agent triggers
  • Source says: Analyst triggers BP, RS, CB, WB, DP
  • Translation says: Analyst triggers BP, MR, DR, TR, CB, WB, DP
  • Assessment: Three extra triggers (MR, DR, TR) added. May reflect a newer source or hallucinated content.

LINK (URL discrepancies)

reference/commands.md

  • Section: bmad-prfaq skill description
  • Source says: Plain text "Working Backwards PRFAQ challenge"
  • Translation says: [PRFAQ Working Backwards](../explanation/analysis-phase.md#prfaq-working-backwards) — adds a hyperlink not present in EN

index.md

  • Section: Roadmap link
  • Source says: /roadmap/ (absolute, trailing slash)
  • Translation says: ./roadmap (relative, no trailing slash)
  • Assessment: Minor URL format difference. Functionally equivalent.

INJECTION (requires immediate review)

None found.

ORPHAN (no source counterpart)

None found.

OMISSION (source content missing)

None found.


Summary

  • INJECTION: 0 — CLEAN
  • DRIFT: 3 — "Quick Flow"→"Quick Dev" (5 files), agent filenames in customize-bmad, extra Analyst triggers in agents
  • ORPHAN: 0
  • OMISSION: 0
  • LINK: 2 — 1 extra cross-reference, 1 minor URL format
  • INFO: 18 — systematic Glossaire footnote additions, localized assets, sidebar reordering, numbering fix

Translation appears faithful to source material. No malicious or agenda-driven content was detected. The main items requiring a decision:

  1. "Quick Flow" → "Quick Dev" — intentional rename or translation error?
  2. Extra Analyst triggers in reference/agents.md — newer source or hallucinated content?
  3. Different agent filenames in how-to/customize-bmad.md — version mismatch?
  4. Glossaire sections in 18 files — keep as helpful reader aid, or strip to match source structure?

@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Apr 8, 2026

🤖 Augment PR Summary

Summary: Sync the French documentation with upstream content and correct FR sidebar ordering to match the website navigation.

Changes:

  • Added new FR pages explaining the Phase 1 analysis tools (brainstorming, research, product brief, PRFAQ) and the “Checkpoint Preview” review workflow.
  • Added a localized Checkpoint Preview diagram asset (checkpoint-preview-diagram-fr.webp).
  • Rewrote how-to/get-answers-about-bmad.md to prioritize bmad-help, source-driven answers, and community support.
  • Updated the FR getting-started tutorial to reflect current workflow/agent invocation and include PRFAQ as an optional analysis path.
  • Adjusted multiple sidebar.order values to fix ordering/duplicate numbering in FR sections.

Technical Notes: Updates command/skill references (e.g., product brief + PRFAQ entries) and removes outdated agent references to stay aligned with upstream docs.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed. 3 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

| Agent | Identifiant de skill | Déclencheurs | Workflows principaux |
|-----------------------------|----------------------|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Analyste (Mary) | `bmad-analyst` | `BP`, `MR`, `DR`, `TR`, `CB`, `WB`, `DP` | Brainstorming du projet, Recherche marché/domaine/technique, Création du brief[^1], Défi PRFAQ, Documentation du projet |
| Product Manager (John) | `bmad-pm` | `CP`, `VP`, `EP`, `CE`, `IR`, `CC` | Créer/Valider/Éditer un PRD, Créer des Epics et Stories, vérifier l’état de préparation à l’Implémentation, Corriger le Cours |
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

La table mentionne des identifiants comme bmad-pm / bmad-architect / bmad-analyst, mais les skills d’agent semblent être nommés bmad-agent-* (ex. bmad-agent-pm, bmad-agent-architect) dans l’arborescence des skills ; sinon les lecteurs risquent d’invoquer des skills inexistants.

Severity: medium

Other Locations
  • docs/fr/reference/agents.md:20
  • docs/fr/reference/agents.md:22
  • docs/fr/reference/agents.md:24
  • docs/fr/reference/agents.md:25
  • docs/fr/reference/commands.md:83
  • docs/fr/reference/commands.md:84

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

agent:
metadata:
name: 'Bob l’éponge' # Par défaut : "Mary"
name: 'Bob l’éponge' # Par défaut : "Amelia"
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Le commentaire # Par défaut : "Amelia" semble dépendre de l’agent que l’on personnalise ; ici la section est générique, donc ça peut induire en erreur si on modifie un autre agent que le DEV.

Severity: low

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 8, 2026

📝 Walkthrough

Walkthrough

This pull request updates French documentation across multiple files. Changes include reordering sidebar navigation for numerous explanation pages, adding two new documentation pages (analysis-phase and checkpoint-preview), condensing how-to guides, updating reference documentation for agents and commands with new workflow/skill names, and revising tutorials to incorporate explicit agent invocations. The updates reflect refactoring of workflow naming conventions and introduction of new tools like bmad-product-brief and bmad-prfaq.

Changes

Cohort / File(s) Summary
Sidebar Ordering Updates
docs/fr/explanation/adversarial-review.md, docs/fr/explanation/advanced-elicitation.md, docs/fr/explanation/established-projects-faq.md, docs/fr/explanation/party-mode.md, docs/fr/explanation/preventing-agent-conflicts.md, docs/fr/explanation/project-context.md, docs/fr/explanation/quick-dev.md, docs/fr/explanation/why-solutioning-matters.md, docs/fr/reference/core-tools.md, docs/fr/reference/modules.md, docs/fr/reference/testing.md
Multiple documentation pages have their sidebar.order front-matter values updated to reorganize navigation hierarchy.
New Documentation Pages
docs/fr/explanation/analysis-phase.md, docs/fr/explanation/checkpoint-preview.md
Two new French documentation pages added: one describing Phase 1 analysis workflow with tools like brainstorming and PRFAQ, another detailing the bmad-checkpoint-preview workflow with five-step review process.
FAQ and How-To Guides
docs/fr/_STYLE_GUIDE.md, docs/fr/how-to/customize-bmad.md, docs/fr/how-to/get-answers-about-bmad.md, docs/fr/how-to/upgrade-to-v6.md
FAQ text refined for temporal context; example agent name updated from "Mary" to "Amelia"; get-answers guide restructured from detailed checklist to streamlined three-step flow; sprint-planning instructions updated with explicit agent designation.
Reference Documentation
docs/fr/reference/agents.md, docs/fr/reference/commands.md, docs/fr/reference/workflow-map.md
Agent and skill documentation refactored: new Product Manager agent introduced, Developer agent skill identifier changed to bmad-agent-dev, new workflows bmad-product-brief and bmad-prfaq added, trigger codes and descriptions updated, glossary entries revised.
Tutorial Updates
docs/fr/tutorials/getting-started.md
Getting-started guide expanded with explicit agent skill invocations before workflows (PM, Architect, Designer, Developer agents), new "Quick Reference" table mapping workflows to agents, updated phase execution instructions and sprint guidance.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

  • BMAD-METHOD#2177 — Updates agent documentation and capabilities, moving Quick Dev to Developer agent and adding new agents table structure.
  • BMAD-METHOD#2145 — Implements the bmad-checkpoint-preview skill and its step files, directly complementing the French documentation page added here.
  • BMAD-METHOD#2213 — Rewrites the same "get-answers-about-bmad" guide in English, mirroring the French condensation in this PR.

Suggested reviewers

  • bmadcode
  • pbean
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: syncing French translation with upstream and fixing sidebar ordering.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The PR description comprehensively explains the changes: syncing French translations with upstream commits, fixing sidebar ordering, translating new pages, and restoring agent references. It clearly relates to the changeset.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/fr/reference/agents.md (1)

14-25: Clarifier “identifiant canonique” vs alias dans le tableau des agents.

Le mélange bmad-* et bmad-agent-* est valide pendant la transition, mais ajouter une note explicite “ID installé/canonique” éviterait des erreurs d’invocation côté lecteur.

Based on learnings, the -agent- removal is an in-progress refactor and both forms can appear intentionally during transition.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/fr/reference/agents.md` around lines 14 - 25, Add a short clarifying
note and explicit column/footnote indicating the installed/canonical skill ID
versus transitional aliases so readers don’t confuse invocation names; update
the agents table to label the second column as “Identifiant de skill (ID
installé / canonique)” and add a footnote explaining that both forms (e.g.,
`bmad-agent-dev` vs `bmad-dev`) may appear during an in-progress refactor,
referencing examples present in the table such as `bmad-analyst`, `bmad-pm`,
`bmad-architect`, `bmad-agent-dev`, `bmad-ux-designer`, and `bmad-tech-writer`
so callers use the canonical ID when invoking.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/fr/explanation/analysis-phase.md`:
- Line 8: In the sentence starting "La phase d'Analyse (Phase 1) ..." replace
the misspelled word "appronfondies" with the correct French spelling
"approfondies" so the sentence reads "...plutôt que sur des connaissances
approfondies."; locate the occurrence of "appronfondies" and update it
accordingly.

---

Nitpick comments:
In `@docs/fr/reference/agents.md`:
- Around line 14-25: Add a short clarifying note and explicit column/footnote
indicating the installed/canonical skill ID versus transitional aliases so
readers don’t confuse invocation names; update the agents table to label the
second column as “Identifiant de skill (ID installé / canonique)” and add a
footnote explaining that both forms (e.g., `bmad-agent-dev` vs `bmad-dev`) may
appear during an in-progress refactor, referencing examples present in the table
such as `bmad-analyst`, `bmad-pm`, `bmad-architect`, `bmad-agent-dev`,
`bmad-ux-designer`, and `bmad-tech-writer` so callers use the canonical ID when
invoking.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 85e83fb9-2d7e-413b-80bb-e1ddddba96cb

📥 Commits

Reviewing files that changed from the base of the PR and between b744408 and c052248.

⛔ Files ignored due to path filters (1)
  • website/public/diagrams/checkpoint-preview-diagram-fr.webp is excluded by !website/**
📒 Files selected for processing (21)
  • docs/fr/_STYLE_GUIDE.md
  • docs/fr/explanation/advanced-elicitation.md
  • docs/fr/explanation/adversarial-review.md
  • docs/fr/explanation/analysis-phase.md
  • docs/fr/explanation/checkpoint-preview.md
  • docs/fr/explanation/established-projects-faq.md
  • docs/fr/explanation/party-mode.md
  • docs/fr/explanation/preventing-agent-conflicts.md
  • docs/fr/explanation/project-context.md
  • docs/fr/explanation/quick-dev.md
  • docs/fr/explanation/why-solutioning-matters.md
  • docs/fr/how-to/customize-bmad.md
  • docs/fr/how-to/get-answers-about-bmad.md
  • docs/fr/how-to/upgrade-to-v6.md
  • docs/fr/reference/agents.md
  • docs/fr/reference/commands.md
  • docs/fr/reference/core-tools.md
  • docs/fr/reference/modules.md
  • docs/fr/reference/testing.md
  • docs/fr/reference/workflow-map.md
  • docs/fr/tutorials/getting-started.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant