i18n(fr): update plugins#144
Conversation
WalkthroughThe changes update French plugin documentation for StudioCMS. They remove a sidebar badge, revise SDK import and usage patterns, and update how routing and configuration data are accessed. Additionally, the plugin interface documentation now includes a new Changes
Sequence Diagram(s)sequenceDiagram
participant Astro
participant SDKCoreJs
participant runSDK
Astro->>SDKCoreJs: Prepare GET.packagePages(...)
Astro->>runSDK: Call runSDK(SDKCoreJs.GET.packagePages(...))
runSDK-->>Astro: Return package pages data
Estimated code review effort2 (~15 minutes) Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
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
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (2)
src/content/docs/fr/plugins/extended.mdx (2)
52-66: Route pattern produces a double “//” – adjust the leading slash.
routealready contains a leading slashconst route = `/${options?.route || 'mon-module-extension'}`; ... pattern: `/${route}/[...slug]`so the resulting pattern becomes
//mon-module-extension/[...slug], which fails to match and breaks page generation.Proposed fix:
- const route = `/${options?.route || 'mon-module-extension'}`; + const route = options?.route || 'mon-module-extension'; - pattern: `/${route}/[...slug]`, + pattern: `/${route}/[...slug]`,
115-121:frontendNavigationLinkslacks a leading slash – inconsistent with the route above.With the previous fix,
routeno longer includes/. The navigation link therefore resolves to a relative path likemon-module-extension, which can break if the component is rendered from a nested URL.- frontendNavigationLinks: [{ label: 'Le titre ici', href: options?.route || 'mon-module-extension' }], + frontendNavigationLinks: [ + { label: 'Le titre ici', href: `/${options?.route || 'mon-module-extension'}` } + ],
🧹 Nitpick comments (3)
src/content/docs/fr/plugins/index.mdx (1)
71-76: Mention the newsetImageServicecapability outside of the code block.The sample interface now exposes
setImageService, but the surrounding prose (e.g. the paragraph “Voici une description…” or the bullet list of setters further down) never references this new hook. Readers scanning only the narrative sections might therefore miss that this capability exists.Consider adding 1-2 explanatory sentences – or a short bullet – right after the code sample to keep the documentation self-contained and discoverable.
src/content/docs/fr/plugins/extended.mdx (2)
157-166: Minor: wrap the SDK request withrunSDKonce only.If
SDKCoreJs.GET.packagePages()already returns a request object, passing it directly torunSDKis fine.
However, some devs mis-read this pattern and attemptrunSDK(await …). A short inline comment here would avoid copy-paste errors downstream.
225-226: Potential hard-coupling to internal route names.Using
Astro.locals.routeMap.mainLinks.contentManagementEditis correct, yet the literal segmentcontentManagementEditis easy to rename in core.
Adding a note (“// utilise la clé routeMap fournie par StudioCMS”) shields readers from assuming this is a fixed string.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/content/docs/fr/plugins/extended.mdx(5 hunks)src/content/docs/fr/plugins/index.mdx(1 hunks)
🧠 Learnings (2)
📓 Common learnings
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.
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.
src/content/docs/fr/plugins/extended.mdx (1)
Learnt from: ArmandPhilippot
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.
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
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.
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.
src/content/docs/fr/plugins/extended.mdx (1)
Learnt from: ArmandPhilippot
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.
⏰ 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
3 participants
Description
Adds changes from #139 to the French translation of the files in
plugins.Summary by CodeRabbit