i18n(fr): update guides#180
Conversation
📝 WalkthroughWalkthroughUpdates French documentation with path references, adds custom frontend rendering guide resources, introduces guides subsection to documentation index, applies topic categorization across version upgrade guides, hides older beta versions from sidebar, and adds French translation for custom frontends sidebar label. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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. Comment |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/content/docs/fr/guides/custom-frontend/rendering.mdx (1)
12-12: Optional: Consider minor typographical and style improvements.Static analysis detected two minor issues:
- A typographical apostrophe character that could be corrected
- A long sentence that could be split for improved readability
These don't impact functionality but could enhance the reading experience.
Based on learnings, improving readability during translation is acceptable when the technical meaning is preserved.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (18)
src/content/docs/fr/guides/contributing/translations.mdx(2 hunks)src/content/docs/fr/guides/custom-frontend/rendering.mdx(2 hunks)src/content/docs/fr/guides/index.mdx(1 hunks)src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-16.mdx(1 hunks)src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-17.mdx(1 hunks)src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-18.mdx(1 hunks)src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx(1 hunks)src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-20.mdx(1 hunks)src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-21.mdx(1 hunks)src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-22.mdx(1 hunks)src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-23.mdx(1 hunks)src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-24.mdx(1 hunks)src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-25.mdx(1 hunks)src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-26.mdx(1 hunks)src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-27.mdx(1 hunks)src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-28.mdx(1 hunks)src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-29.mdx(1 hunks)src/starlight-sidebar/fr.json(1 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: ArmandPhilippot
Repo: withstudiocms/docs PR: 149
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-21.mdx:13-15
Timestamp: 2025-07-24T11:57:15.225Z
Learning: In the withstudiocms/docs repository, when reviewing French translation files, maintain consistency with the English version even if it means keeping unused imports. Structural parity between language versions is prioritized over removing unused code.
Learnt from: ArmandPhilippot
Repo: withstudiocms/docs PR: 149
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-20.mdx:18-18
Timestamp: 2025-07-24T12:00:35.014Z
Learning: In the withstudiocms/docs repository, while translations should maintain structural parity with English versions, improving readability during translation is acceptable when the original text has clear redundancy or readability issues that would also impact the translation quality. The maintainer ArmandPhilippot confirmed this approach is reasonable when the technical meaning is preserved.
Learnt from: ArmandPhilippot
Repo: withstudiocms/docs PR: 130
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-17.mdx:1-11
Timestamp: 2025-04-26T12:29:17.995Z
Learning: When reviewing translations in the withstudiocms/docs repository, compare with the corresponding English version as the source of truth, not with other files in the same target language. French translations should maintain structural parity with their English counterparts.
Learnt from: ArmandPhilippot
Repo: withstudiocms/docs PR: 140
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx:24-24
Timestamp: 2025-07-21T12:16:32.374Z
Learning: In the withstudiocms/docs repository, documentation URLs in the package-catalog may maintain legacy path names for stability and consistency across language versions, even when the actual package names have been updated. Always verify that corresponding files exist before flagging URLs as broken.
📚 Learning: 2025-07-24T11:57:15.225Z
Learnt from: ArmandPhilippot
Repo: withstudiocms/docs PR: 149
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-21.mdx:13-15
Timestamp: 2025-07-24T11:57:15.225Z
Learning: In the withstudiocms/docs repository, when reviewing French translation files, maintain consistency with the English version even if it means keeping unused imports. Structural parity between language versions is prioritized over removing unused code.
Applied to files:
src/content/docs/fr/guides/contributing/translations.mdx
📚 Learning: 2025-04-26T12:29:17.995Z
Learnt from: ArmandPhilippot
Repo: withstudiocms/docs PR: 130
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-17.mdx:1-11
Timestamp: 2025-04-26T12:29:17.995Z
Learning: When reviewing translations in the withstudiocms/docs repository, compare with the corresponding English version as the source of truth, not with other files in the same target language. French translations should maintain structural parity with their English counterparts.
Applied to files:
src/content/docs/fr/guides/contributing/translations.mdx
📚 Learning: 2025-07-24T12:00:35.014Z
Learnt from: ArmandPhilippot
Repo: withstudiocms/docs PR: 149
File: src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-20.mdx:18-18
Timestamp: 2025-07-24T12:00:35.014Z
Learning: In the withstudiocms/docs repository, while translations should maintain structural parity with English versions, improving readability during translation is acceptable when the original text has clear redundancy or readability issues that would also impact the translation quality. The maintainer ArmandPhilippot confirmed this approach is reasonable when the technical meaning is preserved.
Applied to files:
src/content/docs/fr/guides/contributing/translations.mdxsrc/content/docs/fr/guides/custom-frontend/rendering.mdx
🪛 LanguageTool
src/content/docs/fr/guides/index.mdx
[typographical] ~20-~20: Ce signe est un trait d’union, il ne sert qu’à former des mots composés. Employez un tiret ou un autre signe de ponctuation plus approprié.
Context: ...tends personnalisés - Rendu du contenu - Options pour le rendu du contenu sur un fronten...
(TIRET)
src/content/docs/fr/guides/contributing/translations.mdx
[style] ~35-~35: L’adverbe précède le verbe à l’infinitif.
Context: ...s le tableau de bord. Si vous préférez contribuer directement aux traductions dans le dépôt, les trad...
(PLACE_DE_L_ADVERBE)
[typographical] ~35-~35: Caractère d’apostrophe incorrect.
Context: ...aductions sont stockées dans le dossier [`packages/studiocms/src/virtuals/i18n/tra...
(APOS_INCORRECT)
[typographical] ~35-~35: Caractère d’apostrophe incorrect.
Context: ... traductions en anglais dans le fichier [en.json](https://github.com/withstudioc...
(APOS_INCORRECT)
src/content/docs/fr/guides/custom-frontend/rendering.mdx
[typographical] ~12-~12: Caractère d’apostrophe incorrect.
Context: ...ge comme nous le faisons avec le plugin @studiocms/blog. Un plugin de création de pages, par ex...
(APOS_INCORRECT)
[style] ~12-~12: Une phrase longue peut apporter une perte de sens pour le lecteur. Celle-ci peut donc être divisée afin d’apporter de la clarté et du rythme.
Context: ...t être fourni sans mise en page standard, parce qu’il vise plutôt à ce que vous conceviez l...
(POINT_MAIS)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Run Starlight Link Check
- GitHub Check: build-and-push
🔇 Additional comments (23)
src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-16.mdx (1)
5-8: LGTM! Metadata updates are consistent.The addition of
topic: guidesand the sidebar visibility change fromordertohidden: truealign with the PR's objectives to update French translations with changes from PR #177.src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-27.mdx (1)
5-5: LGTM! Metadata addition is consistent.The addition of
topic: guidescorrectly categorizes this upgrade guide. The sidebar visibility remains unchanged, which is appropriate for this more recent beta version.src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-19.mdx (1)
5-8: LGTM! Metadata updates are consistent.The addition of
topic: guidesand the sidebar visibility change tohidden: trueare consistent with the pattern of hiding older beta version guides from navigation while keeping them accessible.src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-25.mdx (1)
5-5: LGTM! Metadata addition is consistent.The addition of
topic: guidescorrectly categorizes this upgrade guide, and the sidebar visibility remains appropriate for this more recent beta version.src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-24.mdx (1)
5-8: LGTM! Metadata updates are consistent.The addition of
topic: guidesand the sidebar change tohidden: truealign with the pattern of hiding older beta version guides from the sidebar navigation.src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-21.mdx (1)
5-8: LGTM! Metadata updates are consistent.The addition of
topic: guidesand the sidebar visibility change tohidden: truefollow the established pattern for older beta version guides.src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-22.mdx (1)
5-8: LGTM! Metadata updates are consistent.The addition of
topic: guidesand the sidebar change tohidden: trueare consistent with hiding older beta version guides from navigation.src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-29.mdx (1)
5-5: LGTM! Metadata addition is consistent.The addition of
topic: guidescorrectly categorizes this upgrade guide. As one of the most recent beta versions, it appropriately remains visible in the sidebar.src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-28.mdx (1)
5-5: LGTM: Metadata categorization added.The
topic: guidesfrontmatter addition properly categorizes this upgrade guide, aligning with the systematic metadata improvements across all version guides in this PR.src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-26.mdx (1)
5-5: LGTM: Consistent metadata addition.The
topic: guidescategorization is correctly applied, maintaining consistency with other version guides.src/content/docs/fr/guides/index.mdx (1)
18-21: LGTM: New custom frontend guides section added.The new "Guides des frontends personnalisés" subsection is properly structured and integrates well with the existing guide categories. The link follows the established pattern and aligns with the corresponding sidebar entry added in
src/starlight-sidebar/fr.json.src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-17.mdx (1)
5-8: LGTM: Metadata and visibility improvements.The addition of
topic: guidescategorization combined withhidden: trueappropriately archives this older beta version guide while keeping it accessible via direct link. This improves sidebar navigation by reducing clutter.src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-23.mdx (1)
5-8: LGTM: Consistent archival pattern applied.The metadata and visibility changes follow the same pattern as other older beta versions, maintaining consistency across the documentation structure.
src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-20.mdx (1)
5-8: LGTM: Metadata consistency maintained.The categorization and hiding changes are consistently applied, matching the pattern established across other older beta version guides.
src/starlight-sidebar/fr.json (1)
20-21: LGTM: Sidebar translation for custom frontends added.The new "custom-frontend" entry is properly formatted and correctly translates to "Frontends personnalisés", aligning with the new custom frontend guides section introduced in the guides index.
src/content/docs/fr/guides/contributing/translations.mdx (2)
7-9: LGTM: Documentation badge added.The "Mis à jour" badge appropriately signals that this page has been recently updated, improving user awareness of current content.
35-35: French translation maintains structural parity with English version; external path verification cannot be completed from docs repository.The French translation at line 35 correctly mirrors the English version with identical path references to
packages/studiocms/src/virtuals/i18n/translations. The external GitHub URLs cannot be verified from within the docs repository, and structural consistency between language versions has been confirmed.src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-18.mdx (2)
5-8: LGTM! Cleaner sidebar configuration.The addition of
topic: guidesprovides proper categorization, and usinghidden: trueis more explicit than the previous high order number approach for hiding the page from the sidebar.
30-31: LGTM! Properly formatted French path references.The link references are correctly formatted with the French locale prefix.
src/content/docs/fr/guides/custom-frontend/rendering.mdx (4)
1-8: LGTM! Clean frontmatter and import updates.The description update is clear, and the ReadMore component import is properly formatted and used in the new section below.
10-10: LGTM! Clear introductory statement.The sentence clearly introduces the dynamic nature of the StudioCMS rendering system.
14-16: LGTM! Clear explanation with proper link reference.The Aside clearly explains the rendering system requirements and provides a properly formatted link to the custom renderers extension documentation.
45-50: LGTM! Well-structured additional resources section.The new "Lectures complémentaires" section provides helpful guidance for readers interested in creating custom renderers, with consistent link references and proper component usage.
Description
Adds changes from #177 to the French translations of
guides(exceptversion-guides/0-1-0-beta-30updated in #178) andstarlight-sidebar/fr.json.I choose to not translate "frontend" to match what we do in the French version of Astro Docs: https://github.com/withastro/docs/blob/main/i18n-guides/fran%C3%A7ais.md#autres-mots-non-traduits
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.