Skip to content

i18n(fr): update docs for beta 25#161

Merged
dreyfus92 merged 2 commits into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-beta25-docs
Aug 26, 2025
Merged

i18n(fr): update docs for beta 25#161
dreyfus92 merged 2 commits into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-beta25-docs

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Aug 26, 2025

Description

Adds changes from #160 to the French translation:

  • translate the new version guide
  • update some badges
  • update a code snippet

Summary by CodeRabbit

  • Documentation
    • Added a new French upgrade guide for 0.1.0-beta.25 with feature and bug-fix notes (sidebar shows a NOUVEAU badge).
    • Updated the Effect doc example to reflect the renamed API symbol and refreshed resource link.
    • Added a “Mis à jour” badge to one how‑it‑works page.
    • Removed outdated “NOUVEAU”/“Mis à jour” badges from other French pages.
    • No functional changes; content and presentation updates only.

@ArmandPhilippot ArmandPhilippot requested a review from a team as a code owner August 26, 2025 10:41
@netlify
Copy link
Copy Markdown

netlify Bot commented Aug 26, 2025

Deploy Preview for studiocms-dev-docs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 2123d01
🔍 Latest deploy log https://app.netlify.com/projects/studiocms-dev-docs/deploys/68ad9ffc0e815f00081a2209
😎 Deploy Preview https://deploy-preview-161--studiocms-dev-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Aug 26, 2025

📝 Walkthrough

Walkthrough

Removed sidebar badge frontmatter from two French docs, added a new French upgrade guide page for 0.1.0-beta.25 with content/imports, and updated the Effect doc frontmatter and a code-snippet import (renamed convertToVanillarunEffect).

Changes

Cohort / File(s) Summary of changes
Frontmatter badge removals
src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-24.mdx, src/content/docs/fr/how-it-works/sdk.mdx
Deleted badge: block from YAML front matter on both pages; no other content edits.
New FR upgrade guide: 0.1.0-beta.25
src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-25.mdx
Added new MDX page with frontmatter (i18nReady, title, description, label, badge, order), imports (ReadMore, QuickUpdate, Aside), QuickUpdate usage, and sections listing features and bug fixes.
Effect docs update
src/content/docs/fr/how-it-works/effect.mdx
Added badge: Mis à jour to frontmatter and updated example code to import/use runEffect instead of convertToVanilla; updated ReadMore link formatting.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • dreyfus92
  • Adammatthiesen

Poem

I hop through docs with tiny paws,
Badges trimmed with careful claws.
Beta.25 blooms, effects renamed,
New pages planted, neatly framed.
A carrot cheers—bon travail, en avant! 🥕🐇

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 571b6fc and 2123d01.

📒 Files selected for processing (1)
  • src/content/docs/fr/how-it-works/effect.mdx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/content/docs/fr/how-it-works/effect.mdx
⏰ 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). (4)
  • GitHub Check: Redirect rules - studiocms-dev-docs
  • GitHub Check: Header rules - studiocms-dev-docs
  • GitHub Check: Pages changed - studiocms-dev-docs
  • GitHub Check: Run Starlight Link Check
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@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: 0

🧹 Nitpick comments (3)
src/content/docs/fr/how-it-works/effect.mdx (1)

40-40: Lien “Ressources” en Markdown cliquable

Améliore la lisibilité et l’accessibilité en rendant l’URL cliquable.

Proposition de diff:

-<ReadMore>Vous souhaitez en savoir plus sur Effect ? Consultez la documentation d’Effect (https://effect.website/docs/getting-started/introduction/).</ReadMore>
+<ReadMore>Vous souhaitez en savoir plus sur Effect ? Consultez la [documentation d’Effect](https://effect.website/docs/getting-started/introduction/).</ReadMore>
src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-25.mdx (2)

21-27: Micro-éditorial: cohérence de style, backticks et nom de marque “Three.js”

  • Harmoniser le style des puces (impératif) pour éviter le mélange “Refonte/Mise à jour/Migre/Optimise”.
  • Encadrer createEffectAPIRoutes avec des backticks.
  • Utiliser l’orthographe officielle “Three.js” (ou three.js) et retirer la virgule avant “pour”.

Proposition de diffs ciblés:

- - Refonte de l’emploi d’Effect pour utiliser les nouveaux utilitaires améliorés du nouveau paquet `@withstudiocms/effect`.
+ - Met à jour l’utilisation d’Effect afin d’employer les nouveaux utilitaires du paquet `@withstudiocms/effect`.

- - Migre les routes d’API vers le nouvel utilitaire createEffectAPIRoutes depuis `@withstudiocms/effect`.
+ - Migre les routes d’API vers le nouvel utilitaire `createEffectAPIRoutes` fourni par `@withstudiocms/effect`.

- - Optimise l’aperçu de la page de connexion sur la page de configuration et la première mise en route.
+ - Optimise l’aperçu de la page de connexion dans la page de configuration et au premier démarrage.

- - Optimise la page de connexion utilisant `threejs`, pour garantir un chargement rapide de la page.
+ - Optimise la page de connexion en utilisant Three.js pour garantir un chargement rapide.

30-32: Micro-éditorial: éviter la répétition et clarifier OAuth

Remplace la répétition “Nettoie… nettoie…” et précise “configuration OAuth initiale”.

Proposition de diff:

- - Nettoie le code, corrige la première configuration d’OAuth et nettoie les anciens utilitaires.
+ - Nettoie le code, corrige la configuration OAuth initiale et supprime les utilitaires hérités.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 3dd4a2b and 571b6fc.

📒 Files selected for processing (4)
  • src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-24.mdx (0 hunks)
  • src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-25.mdx (1 hunks)
  • src/content/docs/fr/how-it-works/effect.mdx (2 hunks)
  • src/content/docs/fr/how-it-works/sdk.mdx (0 hunks)
💤 Files with no reviewable changes (2)
  • src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-24.mdx
  • src/content/docs/fr/how-it-works/sdk.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.
🪛 LanguageTool
src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-25.mdx

[typographical] ~22-~22: Caractère d’apostrophe incorrect.
Context: ...utilitaires améliorés du nouveau paquet @withstudiocms/effect. - Mise à jour pour utiliser le nouveau...

(APOS_INCORRECT)


[typographical] ~23-~23: Caractère d’apostrophe incorrect.
Context: ... à jour pour utiliser le nouveau paquet @withstudiocms/component-registry. - Migre les routes d’API vers le nouve...

(APOS_INCORRECT)


[typographical] ~24-~24: Caractère d’apostrophe incorrect.
Context: ...utilitaire createEffectAPIRoutes depuis @withstudiocms/effect. - Optimise l’aperçu de la page de conn...

(APOS_INCORRECT)


[typographical] ~26-~26: Caractère d’apostrophe incorrect.
Context: ...Optimise la page de connexion utilisant threejs, pour garantir un chargement rapide de ...

(APOS_INCORRECT)

⏰ 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). (4)
  • GitHub Check: Redirect rules - studiocms-dev-docs
  • GitHub Check: Header rules - studiocms-dev-docs
  • GitHub Check: Pages changed - studiocms-dev-docs
  • GitHub Check: Run Starlight Link Check
🔇 Additional comments (5)
src/content/docs/fr/how-it-works/effect.mdx (2)

7-9: Badge “Mis à jour” OK — vérifier la parité avec l’anglais

L’ajout du badge côté FR est cohérent. Merci de confirmer que la page EN “Effect” affiche le même badge pour conserver la parité structurelle entre langues (préférence mainteneur).

Souhaitez-vous que je balaye la version EN et aligne automatiquement si nécessaire ?


31-36: Migration de l’API confirmée : plus aucune occurrence de convertToVanilla
La recherche dans tout le dépôt n’a retourné aucune référence à convertToVanilla et tous les exemples FR/EN utilisent désormais runEffect.
Aucun autre ajustement nécessaire.

src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-25.mdx (3)

13-18: Import d’Aside non utilisé: conserver pour parité

Aside n’est pas utilisé, mais la préférence mainteneur pour ce repo est de garder la parité avec l’anglais même si l’import est inutilisé. Rien à changer si la page EN importe aussi Aside.

Souhaitez-vous que je compare automatiquement avec la page EN et aligne au besoin ?


21-26: Vérification des apostrophes : rien à corriger
Le script de détection n’a retourné aucune occurrence d’apostrophe ASCII (') entre des lettres dans src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-25.mdx. Toutes les apostrophes sont bien typographiques ().


1-11: Frontmatter OK — ordre de la sidebar confirmé

Les champs label, badge et order: 999990 sont cohérents avec la séquence des autres guides de version (beta-24 : 999991, beta-23 : 999992, …, beta-16 : 999999), garantissant le positionnement attendu.

@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-24.mdx Localization changed, will be marked as complete.
fr/guides/upgrade/version-guides/0-1-0-beta-25.mdx Localization added, will be marked as complete.
fr/how-it-works/effect.mdx Localization changed, will be marked as complete.
fr/how-it-works/sdk.mdx Localization changed, 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.

Copy link
Copy Markdown
Member

@dreyfus92 dreyfus92 left a comment

Choose a reason for hiding this comment

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

Merci @ArmandPhilippot 🤘🏻

@dreyfus92 dreyfus92 merged commit cb97d51 into withstudiocms:main Aug 26, 2025
11 of 12 checks passed
@ArmandPhilippot ArmandPhilippot deleted the i18n/fr-update-beta25-docs branch August 26, 2025 16:36
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.

3 participants