Skip to content

i18n(fr): update plugins and utils#156

Merged
dreyfus92 merged 2 commits into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-plugins-and-utils
Aug 6, 2025
Merged

i18n(fr): update plugins and utils#156
dreyfus92 merged 2 commits into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-plugins-and-utils

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Aug 6, 2025

Description

Adds changes from #150 and #151 to the French translations of plugins/index.mdx and utils/rendering.mdx.

Summary by CodeRabbit

  • Documentation
    • Added details about configuring authentication service providers in the plugin setup documentation.
    • Included an informational aside explaining the need for a rendering engine extension when using the StudioCMS rendering system.

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

netlify Bot commented Aug 6, 2025

Deploy Preview for studiocms-dev-docs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 0acb6e4
🔍 Latest deploy log https://app.netlify.com/projects/studiocms-dev-docs/deploys/6893ab73f90c3500088986ea
😎 Deploy Preview https://deploy-preview-156--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 6, 2025

Walkthrough

Two documentation files were updated. The French plugins documentation now describes a new setAuthService method for plugin configuration, detailing its parameters and structure. The French rendering utilities documentation adds an informational aside about required rendering engine extensions, clarifying usage but making no changes to core content.

Changes

Cohort / File(s) Change Summary
Plugin Configuration Docs Update
src/content/docs/fr/plugins/index.mdx
Documents the addition of the setAuthService method to the StudioCMSPlugin interface, detailing its parameters for OAuth provider configuration.
Rendering Utilities Docs Update
src/content/docs/fr/utils/rendering.mdx
Adds an informational aside about the need for a rendering engine extension when using the StudioCMS rendering system. No changes to existing examples or explanations.

Sequence Diagram(s)

sequenceDiagram
    participant PluginDev as Plugin Developer
    participant StudioCMS as StudioCMS Plugin System

    PluginDev->>StudioCMS: Call setAuthService({ oAuthProvider })
    StudioCMS-->>PluginDev: Registers OAuth provider details for authentication
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

  • i18n(fr): update plugins #144: Adds a setImageService method to the same plugin setup interface, similar in scope to the new setAuthService method introduced here.

Suggested labels

i18n

Suggested reviewers

  • dreyfus92

Poem

A bunny hops through docs anew,
With plugins fresh and rendering too!
OAuth now joins the party—
Extensions make the pages arty.
In French it’s clear, in code it’s bright,
StudioCMS leaps to new height!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
🪧 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.
    • Explain this complex logic.
    • 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. Examples:
    • @coderabbitai explain this code block.
  • 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 src/utils.ts and explain its main purpose.
    • @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 comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

Documentation and Community

  • 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.

@studiocms-no-reply
Copy link
Copy Markdown
Member

studiocms-no-reply commented Aug 6, 2025

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/plugins/index.mdx Localization changed, will be marked as complete.
fr/utils/rendering.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
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 (2)
src/content/docs/fr/utils/rendering.mdx (1)

18-20: Reformuler l’aside pour plus de concision
La phrase est un peu longue et contient des répétitions (« module d’extension … fournissant un moteur de rendu » apparaît deux fois). Une formulation plus concise améliorera la lisibilité sans altérer le contenu technique.

-Veuillez noter que l’utilisation de notre système de rendu nécessite que vous disposiez d’un module d’extension pour StudioCMS fournissant un moteur de rendu, tel que `@studiocms/md`, `@studiocms/html` ou un module d’extension personnalisé qui fournit un moteur de rendu pour votre type de contenu. Le moteur de rendu gérera le rendu du contenu en fonction du type de page défini dans votre configuration de StudioCMS.
+Veuillez noter que le système de rendu de StudioCMS requiert un module d’extension fournissant un moteur de rendu (par ex. `@studiocms/md`, `@studiocms/html` ou un module personnalisé).  
+Ce moteur se charge d’afficher le contenu selon le type de page déclaré dans votre configuration StudioCMS.
src/content/docs/fr/plugins/index.mdx (1)

77-85: Mettre l’exemple complet à jour pour illustrer setAuthService
Le bloc d’exemple situé plus bas (lignes 101-130) ne montre pas encore l’utilisation de setAuthService. Ajouter un court extrait renforcerait la compréhension de cette nouvelle API.

@@
     hooks: {
       'studiocms:astro:config': ({ addIntegrations }) => {
         addIntegrations(monIntegration(options)) // Facultatif, mais recommandé
       },
+      'studiocms:config:setup': ({ setAuthService }) => {
+        setAuthService({
+          oAuthProvider: {
+            name: 'github',
+            formattedName: 'GitHub',
+            svg: '<svg>…</svg>',
+            endpointPath: '/api/auth/github',
+            requiredEnvVariables: ['GITHUB_CLIENT_ID', 'GITHUB_CLIENT_SECRET']
+          }
+        })
+      }
     }
   }
 });
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 21b126c and 59e829a.

📒 Files selected for processing (2)
  • src/content/docs/fr/plugins/index.mdx (1 hunks)
  • src/content/docs/fr/utils/rendering.mdx (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 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.
📚 Learning: in the withstudiocms/docs repository, documentation urls in the package-catalog may maintain legacy ...
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#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.

Applied to files:

  • src/content/docs/fr/utils/rendering.mdx
🪛 LanguageTool
src/content/docs/fr/utils/rendering.mdx

[uncategorized] ~16-~16: Le trait d’union doit être supprimé.
Context: ...el. Exemple d’une route fourre-tout (« catch-all » en anglais) où la page actuelle est r...

(MOT_TRAIT_MOT)


[typographical] ~16-~16: 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] ~16-~16: 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). (4)
  • GitHub Check: Run Starlight Link Check
  • GitHub Check: Redirect rules - studiocms-dev-docs
  • GitHub Check: Header rules - studiocms-dev-docs
  • GitHub Check: Pages changed - studiocms-dev-docs
🔇 Additional comments (2)
src/content/docs/fr/utils/rendering.mdx (1)

12-13: Import statement looks correct
L’import du composant Aside depuis @astrojs/starlight/components est conforme à la convention employée dans le reste de la documentation.

src/content/docs/fr/plugins/index.mdx (1)

77-85: Bien vu ! L’API setAuthService est correctement intégrée
La nouvelle définition reflète fidèlement la version anglaise : propriétés, typage optionnel et cohérence de l’indentation sont respectés.

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.

LGTM ✍🏻

@dreyfus92 dreyfus92 merged commit 98afceb into withstudiocms:main Aug 6, 2025
12 checks passed
@ArmandPhilippot ArmandPhilippot deleted the i18n/fr-update-plugins-and-utils branch August 6, 2025 19: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