Skip to content

i18n(fr): update docs for beta.28#171

Merged
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-beta28-docs
Nov 4, 2025
Merged

i18n(fr): update docs for beta.28#171
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-beta28-docs

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Oct 30, 2025

Description

Adds changes from #170 to the French translation.

Summary by CodeRabbit

  • Documentation
    • Added new French upgrade guide for version 0-1-0-beta-28 with details on breaking changes, new features, and improvements.
    • Added comprehensive documentation for creating plugin rendering extension modules.
    • Updated extended plugin documentation with translation support examples.

@ArmandPhilippot ArmandPhilippot requested a review from a team as a code owner October 30, 2025 15:41
@ghost
Copy link
Copy Markdown

ghost commented Oct 30, 2025

🚨 Preview Deployment Blocked - Security Protection

Your pull request was blocked from triggering preview deployments

Why was this blocked?

  • User: ArmandPhilippot
  • Repository: docs
  • Permission Level: read
  • Required Level: write, maintain, or admin

How to resolve this:

Option 1: Get Collaborator Access (Recommended)
Ask a repository maintainer to invite you as a collaborator with write permissions or higher.

Option 2: Request Permission Override
Ask a repository administrator to disable security validation for this specific application if appropriate.

For Repository Administrators:

To disable this security check (⚠️ not recommended for public repositories):
Enter to preview settings and disable the security check.


This security measure protects against malicious code execution in preview deployments. Only trusted collaborators should have the ability to trigger deployments.

🛡️ Learn more about this security feature

This protection prevents unauthorized users from:

  • Executing malicious code on the deployment server
  • Accessing environment variables and secrets
  • Potentially compromising the infrastructure

Preview deployments are powerful but require trust. Only users with repository write access can trigger them.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Oct 30, 2025

📝 Walkthrough

Walkthrough

This PR updates French documentation by removing a "NOUVEAU" badge from the 0-1-0-beta-27 upgrade guide, adding a new 0-1-0-beta-28 upgrade guide page with version-specific details, refreshing the extended plugins documentation with a badge and translation examples, and introducing a new rendering extension modules guide with code samples.

Changes

Cohort / File(s) Change Summary
Upgrade Guide Badge Removal
src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-27.mdx
Removed "NOUVEAU" badge (success variant) from frontmatter sidebar configuration
New Upgrade Guide
src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-28.mdx
Added new version guide documentation with frontmatter configuration, component imports (ReadMore, QuickUpdate, Aside), and detailed sections covering breaking changes, new features, bug fixes, and UI/UX improvements
Plugin Documentation Updates
src/content/docs/fr/plugins/extended.mdx
Added "Mis à jour" badge (success variant) to sidebar and extended studioCMSPageInjector dashboard setup with translations object containing example keys (title, other-text) for both English and French locales
New Renderer Extension Guide
src/content/docs/fr/plugins/renderers.mdx
Added new documentation page for creating rendering extension modules, including code examples for plugin registration (definePlugin), renderer component implementation (PluginRenderer), and Astro editor component with textarea binding

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Verify the translations example code structure in extended.mdx matches the actual API expectations
  • Confirm the code examples in renderers.mdx (module structure, component exports, and Astro component) are syntactically and semantically accurate with current StudioCMS conventions
  • Review that frontmatter metadata (i18n, sidebar badges, descriptions) is consistent across all documentation pages

Possibly related PRs

  • Beta.24 docs #158: Applies similar documentation frontmatter badge changes and adds French equivalents of updated docs including the upgrade guide and renderer pages
  • i18n(fr): add plugins pages #36: Modifies the same French plugins file and introduces the studioCMSPageInjector setup that is now being extended with translations
  • i18n(fr): update plugins #144: Updates the same extended.mdx file with sidebar badge and plugin/dashboard configuration changes

Suggested reviewers

  • dreyfus92
  • Adammatthiesen

Poem

🐰 A badge removed, a guide refreshed anew,
French docs blooming in the morning dew.
Renderers dance with examples so bright,
Translation translations—hopping through the night!
thump thump 📚✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "i18n(fr): update docs for beta.28" directly describes the primary changes in this pull request. The changeset focuses on updating French documentation files, including adding a new beta.28 version guide, creating new French documentation for plugin renderers, and updating the extended plugins documentation page. The title accurately captures the scope (French language documentation via the i18n/fr convention), the action (update), and the context (beta.28 version). The title is concise, uses standard conventional commit formatting, and avoids vague language or noise, making it clear to developers reviewing the history.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dd5fdd9 and 05ef5d7.

📒 Files selected for processing (4)
  • src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-27.mdx (0 hunks)
  • src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-28.mdx (1 hunks)
  • src/content/docs/fr/plugins/extended.mdx (2 hunks)
  • src/content/docs/fr/plugins/renderers.mdx (1 hunks)
💤 Files with no reviewable changes (1)
  • src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-27.mdx
🧰 Additional context used
🧠 Learnings (1)
📓 Common learnings
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#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
PR: withstudiocms/docs#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
PR: withstudiocms/docs#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.
🪛 LanguageTool
src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-28.mdx

[grammar] ~1-1: Il y a peut-être une erreur ici
Context: --- i18nReady: true title: "Mise à niveau : 0.1.0-beta.28" description: Mettre à niveau StudioCMS vers la version Beta.28 sidebar: label: 0.1.0-beta.28 badge: text: NOUVEAU variant: success order: 999987 --- import ReadMore from '
/components/ReadM...

(QB_NEW_FR)


[grammar] ~15-~15: Il y a peut-être une erreur ici
Context: ...e } from '@astrojs/starlight/components' ## Modifications avec rupture de compatibil...

(QB_NEW_FR)


[grammar] ~20-~20: Il y a peut-être une erreur ici
Context: ...ètre doivent passer à une autre méthode. - Implémente un nouveau système de rendu p...

(QB_NEW_FR)


[grammar] ~21-~21: Il y a peut-être une erreur ici
Context: ...enté des moteurs de rendu personnalisés. Consultez la [documentation d...

(QB_NEW_FR)


[grammar] ~22-~22: Il y a peut-être une erreur ici
Context: ...rendu existants vers le nouveau système. - Déprécie les anciennes tables StudioCMSS...

(QB_NEW_FR)


[grammar] ~23-~23: Il y a peut-être une erreur ici
Context: ... supprimées dans une version ultérieure. - Les utilisateurs devront exécuter la com...

(QB_NEW_FR)


[typographical] ~24-~24: Ces deux traits d’union peuvent être associés pour former un tiret.
Context: ...ilisateurs devront exécuter la commande astro db push --remote pour s’assurer que leurs schémas...

(TIRET)


[style] ~24-~24: Cette structure peut être modifiée afin de devenir plus percutante.
Context: ...emote` pour s’assurer que leurs schémas de base de données sont à jour. ## Nouvelles f...

(DE_BASE3)


[grammar] ~27-~27: Il y a peut-être une erreur ici
Context: ...ectement depuis l’interface utilisateur. - Active la prise en charge multilingue du...

(QB_NEW_FR)


[grammar] ~28-~28: Il y a peut-être une erreur ici
Context: ...ilingue du tableau de bord de StudioCMS. - Implémente un meilleur type de route d’A...

(QB_NEW_FR)


[typographical] ~29-~29: Caractère d’apostrophe incorrect.
Context: ...lémente un meilleur type de route d’API (PluginAPIRoute) à partir de l’exportati...

(APOS_INCORRECT)


[typographical] ~29-~29: Caractère d’apostrophe incorrect.
Context: ...s/pluginspour les gestionnaires d’APIonCreate, onEditetonDelete` des modules d’e...

(APOS_INCORRECT)


[grammar] ~29-~29: Il y a peut-être une erreur ici
Context: ...etonDelete` des modules d’extension. - Réorganise les pages de création et de m...

(QB_NEW_FR)


[grammar] ~30-~30: Il y a peut-être une erreur ici
Context: ...si que la page de configuration de SMTP. ## Corrections de bugs et améliorations - M...

(QB_NEW_FR)


[style] ~33-~33: Un autre mot peut sembler plus précis et percutant.
Context: ... Corrections de bugs et améliorations - Met à jour @studiocms/ui@1.0.0-beta.3 et nettoie...

(METTRE_A_JOUR)


[grammar] ~33-~33: Il y a peut-être une erreur ici
Context: ...t nettoie les styles désormais inutiles. - Remplace l’icône de recherche CSS person...

(QB_NEW_FR)


[grammar] ~34-~34: Il y a peut-être une erreur ici
Context: ...nt Input et supprime le CSS inutilisé. - Corrige l’analyse de validation des form...

(QB_NEW_FR)


[grammar] ~35-~35: Il y a peut-être une erreur ici
Context: ...ns pour les pages de gestion de contenu. - Met à jour le bouton de commentaires pou...

(QB_NEW_FR)


[style] ~36-~36: Un autre mot peut sembler plus précis et percutant.
Context: ...pour les pages de gestion de contenu. - Met à jour le bouton de commentaires pour diriger ...

(METTRE_A_JOUR)


[grammar] ~36-~36: Il y a peut-être une erreur ici
Context: ...tendant l’intégration d’astro-feedback). - Corrige l’analyse d’erreur zod pour les ...

(QB_NEW_FR)


[grammar] ~37-~37: «  zod  » semble plus probable dans ce contexte
Context: ... d’astro-feedback). - Corrige l’analyse d’erreur zod pour les réponses des routes d’API lors...

(QB_NEW_FR_OTHER_ERROR_IDS_REPLACEMENT_ORTHOGRAPHY_LOWERCASE)


[grammar] ~37-~37: Il y a peut-être une erreur ici
Context: ...d’API lors de la première configuration. - Met à jour les outils d’accès rapide, la...

(QB_NEW_FR)


[style] ~38-~38: Un autre mot peut sembler plus précis et percutant.
Context: ...PI lors de la première configuration. - Met à jour les outils d’accès rapide, la page de d...

(METTRE_A_JOUR)


[grammar] ~38-~38: Il y a peut-être une erreur ici
Context: ...boutons pour utiliser les requêtes POST. - Optimise le cache des middlewares pour d...

(QB_NEW_FR)


[grammar] ~39-~39: Il y a peut-être une erreur ici
Context: ...ewares pour des performances améliorées. - Refaçonne la structure interne des fichi...

(QB_NEW_FR)


[grammar] ~40-~40: Il y a peut-être une erreur ici
Context: ... simplifier la maintenance à long terme. - Améliore le traitement des données de cr...

(QB_NEW_FR)


[grammar] ~41-~41: Il y a peut-être une erreur ici
Context: ... cohérence et une plus grande fiabilité. - Déplace le chargement des avatars côté c...

(QB_NEW_FR)


[grammar] ~42-~42: Il y a peut-être une erreur ici
Context: ...lient pour éliminer le blocage du rendu. {/* Liens */} [plugin-renderer-docs]: /f...

(QB_NEW_FR)


[grammar] ~45-~45: Il y a peut-être une erreur ici
Context: ...u. {/* Liens */} [plugin-renderer-docs]: /fr/plugins/renderers/

(QB_NEW_FR)


[grammar] ~45-~45: Il y a peut-être une erreur ici
Context: ...n-renderer-docs]: /fr/plugins/renderers/

(QB_NEW_FR)

src/content/docs/fr/plugins/renderers.mdx

[grammar] ~1-1: Il y a peut-être une erreur ici
Context: --- i18nReady: true title: Modules d’extension de moteur de rendu description: Découvrez les modules d’extension de moteur de rendu pour StudioCMS et apprenez à en créer. sidebar: order: 3 badge: text: NOUVEAU variant: success --- import ReadMore from '
/components/ReadM...

(QB_NEW_FR)


[grammar] ~12-12: Il y a peut-être une erreur ici
Context: ...dMore from '
/components/ReadMore.astro' # Présentation Les modules d’extension de...

(QB_NEW_FR)


[grammar] ~14-~14: Il y a peut-être une erreur ici
Context: ...mponents/ReadMore.astro' # Présentation Les modules d’extension de moteur de ren...

(QB_NEW_FR)


[grammar] ~16-~16: Il y a peut-être une erreur ici
Context: ...tres modifications au pipeline de rendu. ## Création d’un module d’extension de mote...

(QB_NEW_FR)


[grammar] ~18-~18: Il y a peut-être une erreur ici
Context: ...un module d’extension de moteur de rendu ### Le fichier principal du module d’extensi...

(QB_NEW_FR)


[grammar] ~20-~20: Il y a peut-être une erreur ici
Context: ... fichier principal du module d’extension Pour créer un module d’extension de mote...

(QB_NEW_FR)


[grammar] ~53-~53: Il y a peut-être une erreur ici
Context: ...``` ### Le composant de moteur de rendu Pour le composant de moteur de rendu, vo...

(QB_NEW_FR)


[typographical] ~55-~55: Caractère d’apostrophe incorrect.
Context: ...) qui exporte un objet conforme au type PluginRenderer. Cet objet doit inclure la logique de r...

(APOS_INCORRECT)


[grammar] ~55-~55: Il y a peut-être une erreur ici
Context: ...endu de votre type de page personnalisé. ts twoslash title="components/render.js" import type { PluginRenderer } from 'studiocms/types'; const render = { name: 'mon-moteur-rendu-personnalise', renderer: async (content: string) => { // La logique de rendu personnalisée se trouve ici return content; }, sanitizeOpts: {}, } satisfies PluginRenderer; export default render; ### Le composant d’édition Pour le composan...

(QB_NEW_FR)


[grammar] ~72-~72: Il y a peut-être une erreur ici
Context: ... render; ``` ### Le composant d’édition Pour le composant d’édition, vous devez ...

(QB_NEW_FR)


[style] ~74-~74: Une autre expression peut sembler plus percutante.
Context: ... Ce composant recevra le contenu actuel en tant que propriété et devra émettre des mises à ...

(EN_TANT_QUE1)


[style] ~74-~74: Un autre mot peut sembler plus précis et percutant.
Context: ...n composant d’édition personnalisé doit mettre à jour la valeur de ce champ <textarea> afin...

(METTRE_A_JOUR)


[grammar] ~74-~74: Il y a peut-être une erreur ici
Context: ...le contenu soit correctement enregistré. astro title="components/Editor.astro" --- import type { PluginPageTypeEditorProps } from 'studiocms/types'; interface Props extends PluginPageTypeEditorProps {} const { content } = Astro.props; --- <div class="editor-container"> <textarea id="page-content" name="page-content">{content}</textarea> </div>

(QB_NEW_FR)

⏰ 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). (1)
  • GitHub Check: Run Starlight Link Check
🔇 Additional comments (8)
src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-28.mdx (2)

13-45: Content sections are well-organized and reference the new rendering system appropriately.

The breaking changes, new features, and bug fixes sections provide comprehensive upgrade information. The ReadMore link to plugin renderer documentation at line 22 is correctly referenced.


1-11: Frontmatter is correct and properly translated.

The French guide uses "NOUVEAU" (correct translation of "NEW") in the badge, matches the English version structure, and maintains proper sidebar ordering (999987) for the newest beta release. The i18nReady flag and all frontmatter fields follow Starlight conventions. No issues detected.

src/content/docs/fr/plugins/renderers.mdx (4)

57-70: Renderer component example correctly demonstrates the PluginRenderer type pattern.

The code shows:

  • Proper PluginRenderer type usage with satisfies keyword
  • Required fields: name, renderer (async function), sanitizeOpts
  • Default export of the renderer object

The implementation is straightforward and matches expected StudioCMS plugin patterns. Ensure the English version uses identical type definitions and structure.


76-87: Editor component example correctly implements the PluginPageTypeEditorProps interface.

The Astro component properly:

  • Imports and extends PluginPageTypeEditorProps
  • Receives content via Astro.props
  • Binds content to a textarea for editing with correct attributes (id, name)

This implementation follows the pattern described in the prose (line 74) for ensuring content updates are properly captured. Verify alignment with the English documentation's editor component example.


24-51: Code examples are consistent across French and English versions; API structure verified.

Both language versions use identical API signatures and structure for the plugin definition. The differences are translations and example identifiers, which is correct for localized documentation. The code correctly demonstrates the definePlugin API with the setRendering hook for the beta.28 release.


1-10: French rendering plugins documentation correctly configured with proper translation and structural parity.

The frontmatter is properly configured with i18nReady flag, translated title ("Modules d'extension de moteur de rendu"), and localized badge text ("NOUVEAU"). The sidebar order (3) and badge variant (success) match the English version. Code examples remain identical across both versions as expected.

src/content/docs/fr/plugins/extended.mdx (2)

7-9: Sidebar badge addition is correct and consistent with English version.

The French translation "Mis à jour" properly matches the English "Updated" text, and both versions maintain identical structure with the variant: success field. The changes align with documentation conventions and maintain structural parity across language versions.


95-108: Structural parity verified between English and French translation blocks.

The script output confirms that both src/content/docs/en/plugins/extended.mdx and src/content/docs/fr/plugins/extended.mdx contain identical translation structures with matching keys and properly nested en and fr namespaces. The code is syntactically valid, and translations maintain consistency with the source language.


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.

@studiocms-no-reply
Copy link
Copy Markdown
Member

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
fr/guides/upgrade/version-guides/0-1-0-beta-27.mdx Localization changed, will be marked as complete.
fr/guides/upgrade/version-guides/0-1-0-beta-28.mdx Localization added, will be marked as complete.
fr/plugins/extended.mdx Localization changed, will be marked as complete.
fr/plugins/renderers.mdx Localization added, will be marked as complete.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@Adammatthiesen Adammatthiesen merged commit b0beb48 into withstudiocms:main Nov 4, 2025
8 checks passed
@ArmandPhilippot ArmandPhilippot deleted the i18n/fr-update-beta28-docs branch November 4, 2025 11:36
This was referenced Dec 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants