Skip to content

i18n(fr): update plugins#188

Merged
dreyfus92 merged 2 commits into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-plugins
Dec 21, 2025
Merged

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

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Dec 21, 2025

Description

Adds changes from #177 to the French translations in plugins.

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced new plugin hooks: studiocms:frontend, studiocms:rendering, studiocms:image-service, and studiocms:sitemap for enhanced plugin customization.
    • Added studiocms:auth hook for authentication configuration.
  • Documentation

    • Updated plugin documentation with improved guidance and caution badges.
    • Added supplementary reading sections for custom renderers and frontend configuration.
  • Chores

    • Updated minimum StudioCMS version requirement to 0.1.0-beta.31.
    • Restructured plugin hook naming for clarity.

✏️ Tip: You can customize this high-level summary in your review settings.

@ArmandPhilippot ArmandPhilippot requested a review from a team as a code owner December 21, 2025 14:55
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Dec 21, 2025

📝 Walkthrough

Walkthrough

Documentation update to French StudioCMS plugin guides reflecting a major refactoring of the plugin lifecycle hook architecture. The 'studiocms:config:setup' hook is split into specialized 'studiocms:dashboard', 'studiocms:frontend', and 'studiocms:rendering' hooks. Minimum StudioCMS version bumped from 0.1.0-beta.18 to 0.1.0-beta.31 across affected files.

Changes

Cohort / File(s) Summary
French plugin documentation
src/content/docs/fr/plugins/extended.mdx, index.mdx, renderers.mdx
Version bump to 0.1.0-beta.31; hook refactoring from 'studiocms:config:setup' to separate 'studiocms:dashboard', 'studiocms:frontend', and 'studiocms:rendering' hooks; 'studiocms:astro:config' renamed to 'studiocms:astro-config'; added new public hook signatures ('studiocms:auth', 'studiocms:image-service', 'studiocms:sitemap'); updated sidebar badges and navigation labels; added "Lectures complémentaires" section in renderers guide.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • Hook refactoring verification: Ensure all three files correctly document the split of 'studiocms:config:setup' into dashboard/frontend/rendering hooks with accurate handler signatures and parameter shapes.
  • Version consistency: Verify that all minimum version references (0.1.0-beta.31) are consistent across files and align with actual API availability.
  • Hook naming accuracy: Double-check that 'studiocms:astro:config' → 'studiocms:astro-config' renaming is applied uniformly and matches the actual implementation.
  • Public API documentation: Confirm that new hooks ('studiocms:auth', 'studiocms:image-service', 'studiocms:sitemap') and their parameter signatures are correctly documented in index.mdx.

Possibly related PRs

Suggested reviewers

  • Adammatthiesen

Poem

🐰 Hooks hop and skip in new design,
Dashboard, frontend, rendering align,
One becomes three, the API takes flight,
French docs updated—the future looks bright!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately describes the main change: updating French translations for the plugins documentation section, which aligns with all three modified files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a6a49e6 and 0a7f5b2.

📒 Files selected for processing (3)
  • src/content/docs/fr/plugins/extended.mdx (2 hunks)
  • src/content/docs/fr/plugins/index.mdx (4 hunks)
  • src/content/docs/fr/plugins/renderers.mdx (3 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 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.
📚 Learning: 2025-12-21T14:44:48.926Z
Learnt from: ArmandPhilippot
Repo: withstudiocms/docs PR: 185
File: src/content/docs/fr/utils/template-lang.mdx:1-187
Timestamp: 2025-12-21T14:44:48.926Z
Learning: In French documentation under withstudiocms/docs, localize code example identifiers to the target language for pedagogical content (e.g., use 'utilisateur' instead of 'user', 'commande' instead of 'order') to improve readability. Do this only in documentation/examples meant for learning, and do not apply to production source code. Apply this guideline consistently across French docs.

Applied to files:

  • src/content/docs/fr/plugins/renderers.mdx
  • src/content/docs/fr/plugins/index.mdx
  • src/content/docs/fr/plugins/extended.mdx
🪛 LanguageTool
src/content/docs/fr/plugins/index.mdx

[typographical] ~106-~106: Une espace est requise.
Context: ...sage dans la console lorsque le crochet astro:config:setup est appelé. Pou...

(DEUX_POINTS_ESPACE)

⏰ 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 (6)
src/content/docs/fr/plugins/extended.mdx (1)

88-149: LGTM! Hook refactoring is well-documented.

The updated plugin lifecycle demonstrates the new specialized hooks (studiocms:dashboard, studiocms:frontend, studiocms:rendering) cleanly separating concerns. The version bump to 0.1.0-beta.31 is consistent across the PR, and the French identifiers in examples follow the repository's localization guidelines.

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

23-62: LGTM! Comprehensive type definition update.

The StudioCMSPlugin type definition now properly documents all the new specialized hooks (studiocms:auth, studiocms:dashboard, studiocms:frontend, studiocms:rendering, studiocms:image-service, studiocms:sitemap). The badge addition effectively signals the API revision to readers.


31-34: Verify hook name consistency: studiocms:astro:config vs studiocms:astro-config

The type definition shows studiocms:astro:config (with colons), but the code example on line 99 and in extended.mdx use studiocms:astro-config (with a hyphen). Please verify with the English source which is the correct hook name after the refactoring.


94-106: LGTM! Example code properly updated.

The example correctly demonstrates the plugin definition with the updated minimum version and the renamed hook. The explanatory text accurately reflects the changes.

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

35-50: LGTM! Renderer plugin hook updated correctly.

The transition from studiocms:config:setup to the specialized studiocms:rendering hook is properly documented. The setRendering handler and pageTypes configuration remain consistent with the new architecture.


88-93: Good addition of cross-reference documentation.

The new "Lectures complémentaires" section with the ReadMore component provides helpful guidance for users wanting to create custom frontends with their rendering plugins.


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

studiocms-no-reply commented Dec 21, 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/extended.mdx Localization changed, will be marked as complete.
fr/plugins/index.mdx Localization changed, will be marked as complete.
fr/plugins/renderers.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.

@dreyfus92 dreyfus92 merged commit fec2a51 into withstudiocms:main Dec 21, 2025
8 of 9 checks passed
@ArmandPhilippot ArmandPhilippot deleted the i18n/fr-update-plugins branch December 21, 2025 20:22
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