i18n(fr): add versions-guides/0-1-0-beta-18 and update other files#134
Conversation
WalkthroughThis update modifies French documentation for StudioCMS, focusing on JWT generation instructions, plugin interface changes, and upgrade guides. It introduces a new hook-based plugin system, updates JWT-related documentation and environment variable comments, adds a new upgrade guide for version 0.1.0-beta.18, and revises sidebar badges for clarity and consistency. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant Plugin
participant StudioCMS
User->>Docs: Reads plugin documentation
Docs->>User: Shows new hook-based plugin API
User->>Plugin: Implements hooks ('studiocms:astro:config', 'studiocms:config:setup')
Plugin->>StudioCMS: Registers integrations, dashboard items, navigation, etc. via hooks
StudioCMS-->>User: Loads plugin with new configuration
Possibly related PRs
Suggested reviewers
Poem
Tip ⚡️ Faster reviews with caching
Enjoy the performance boost—your workflow just got faster. 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
🧹 Nitpick comments (5)
src/content/docs/fr/guides/database/sqld-server.mdx (3)
57-57: Clarify terminology: JWT is signed, not “chiffré”
JWTs are typically signés avec votre clé privée plutôt qu’« chiffrés ». Consider updating the text to:-Le résultat est le jeton d'authentification JWT chiffré avec votre clé privée … +Le résultat est le jeton d'authentification JWT signé avec votre clé privée …🧰 Tools
🪛 LanguageTool
[style] ~57-~57: Une autre expression peut sembler plus percutante.
Context: ...clé privée au format standard et encodé en tant quebase64URL, qui sera utilisé pour l’au...(EN_TANT_QUE1)
[typographical] ~57-~57: Caractère d’apostrophe incorrect.
Context: ...u format standard et encodé en tant quebase64URL, qui sera utilisé pour l’authentificati...(APOS_INCORRECT)
[style] ~57-~57: Les chiffres s’écrivent généralement en lettres.
Context: ...ez à l’esprit que le token sera valable 1 an ! ### Mettez à jour votre fichier `...(NOMBRES_EN_LETTRES_2_IMPROVED)
63-63: Wrap placeholder in quotes for clarity
To avoid ambiguity in the.env, it may help to show the token in quotes. For example:-ASTRO_DB_APP_TOKEN= # collez ici votre jeton d’authentification JWT standard +ASTRO_DB_APP_TOKEN="<collez ici votre jeton JWT standard>"
107-107: Unify “base64URL” casing and quoting in Docker snippet
Use consistent casing and quote the value in the compose file:- - SQLD_AUTH_JWT_KEY=collez votre jeton JWT encodé en tant que Base64URL ici + - SQLD_AUTH_JWT_KEY="<collez votre jeton JWT encodé en base64URL>"src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-18.mdx (2)
21-21: French style: prefer “fondé sur” over “basé sur”
“système de modules d’extension fondé sur les hooks” sonne plus naturel en français.🧰 Tools
🪛 LanguageTool
[style] ~21-~21: Utilisé hors du contexte militaire, on préfèrera d’autres tournures à « baser sur ».
Context: ... Nouveau système de modules d’extension basé sur les hooks - Consultez la mise à jour de...(BASER_SUR)
31-31: Translate the English comment “Links” into French
Replace/* Links */with/* Liens */for consistency in the French docs.🧰 Tools
🪛 LanguageTool
[style] ~31-~31: Alternatives possibles pour cet anglicisme :
Context: ...ns une prochaine version. {/* Links */} [plugin-doc]: /fr/plugins/ [cli-doc...(FR_SIMPLE_REPLACE_ANGLICISM_PREMIUM_LINKS)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
src/content/docs/fr/guides/database/sqld-server.mdx(2 hunks)src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-17.mdx(0 hunks)src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-18.mdx(1 hunks)src/content/docs/fr/how-it-works/cli.mdx(1 hunks)src/content/docs/fr/plugins/extended.mdx(2 hunks)src/content/docs/fr/plugins/index.mdx(3 hunks)
💤 Files with no reviewable changes (1)
- src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-17.mdx
🧰 Additional context used
🪛 LanguageTool
src/content/docs/fr/guides/database/sqld-server.mdx
[style] ~57-~57: Une autre expression peut sembler plus percutante.
Context: ...clé privée au format standard et encodé en tant que base64URL, qui sera utilisé pour l’au...
(EN_TANT_QUE1)
[typographical] ~57-~57: Caractère d’apostrophe incorrect.
Context: ...u format standard et encodé en tant que base64URL, qui sera utilisé pour l’authentificati...
(APOS_INCORRECT)
[style] ~57-~57: Les chiffres s’écrivent généralement en lettres.
Context: ...ez à l’esprit que le token sera valable 1 an ! ### Mettez à jour votre fichier `...
(NOMBRES_EN_LETTRES_2_IMPROVED)
[style] ~59-~59: Un autre mot peut sembler plus précis et percutant.
Context: ...t que le token sera valable 1 an ! ### Mettez à jour votre fichier .env de StudioCMS avec ...
(METTRE_A_JOUR)
[typographical] ~59-~59: Il manque une espace après le point.
Context: ...1 an ! ### Mettez à jour votre fichier .env de StudioCMS avec les éléments suivant...
(ESPACE_APRES_POINT)
src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-18.mdx
[style] ~21-~21: Utilisé hors du contexte militaire, on préfèrera d’autres tournures à « baser sur ».
Context: ... Nouveau système de modules d’extension basé sur les hooks - Consultez la mise à jour de...
(BASER_SUR)
[uncategorized] ~25-~25: Le trait d’union doit être supprimé.
Context: ... bugs - Refactorisation de la commande gen-jwt - Consultez la mise à jour de la [docu...
(MOT_TRAIT_MOT)
[style] ~31-~31: Alternatives possibles pour cet anglicisme :
Context: ...ns une prochaine version. {/* Links */} [plugin-doc]: /fr/plugins/ [cli-doc...
(FR_SIMPLE_REPLACE_ANGLICISM_PREMIUM_LINKS)
[uncategorized] ~32-~32: Les deux-points sont précédés d’une espace insécable.
Context: ...ion. {/* Links */} [plugin-doc]: /fr/plugins/ [cli-doc]: /fr/how-it-work...
(FRENCH_WHITESPACE)
[uncategorized] ~33-~33: Les deux-points sont précédés d’une espace insécable.
Context: ... */} [plugin-doc]: /fr/plugins/ [cli-doc]: /fr/how-it-works/cli/#crypto-gen-jwt
(FRENCH_WHITESPACE)
[uncategorized] ~33-~33: Le trait d’union doit être supprimé.
Context: ...lugin-doc]: /fr/plugins/ [cli-doc]: /fr/how-it-works/cli/#crypto-gen-jwt
(MOT_TRAIT_MOT)
[uncategorized] ~33-~33: Le trait d’union doit être supprimé.
Context: ...ugins/ [cli-doc]: /fr/how-it-works/cli/#crypto-gen-jwt
(MOT_TRAIT_MOT)
src/content/docs/fr/plugins/index.mdx
[uncategorized] ~118-~118: 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: ...odule d’extension pour StudioCMS appelé Mon module d’extension qui nécessite la ve...
(POINT_DET)
[typographical] ~118-~118: Une espace est requise.
Context: ...sage dans la console lorsque le crochet astro:config:setup est appelé. Pour plus ...
(DEUX_POINTS_ESPACE)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Run Starlight Link Check
🔇 Additional comments (14)
src/content/docs/fr/how-it-works/cli.mdx (1)
7-9: Added “Mis à jour” badge to indicate updated content
The new badge in the sidebar metadata clearly highlights that this page has been refreshed for the 0.1.0-beta-18 release.src/content/docs/fr/guides/database/sqld-server.mdx (1)
55-55: Verify CLI command signature change
The<PackageManagers>snippet correctly reflects the removal of the-c, --claimoption and only includes the key file and expiration. This matches the newgen-jwtbehavior described in the upgrade guide.src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-18.mdx (3)
1-4: Frontmatter metadata added for the new upgrade guide
Thei18nReady, title, and description entries correctly initialize this new 0.1.0-beta-18 upgrade document.
7-10: Sidebar badge marking the guide as “NOUVEAU”
TheNOUVEAUbadge withsuccessvariant and proper ordering is consistent with other version guides.
25-25: Bug-fixes section bullet is clear and accurate
Referencing the CLI docs for thegen-jwtrefactor aligns with linked changes.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: Le trait d’union doit être supprimé.
Context: ... bugs - Refactorisation de la commandegen-jwt- Consultez la mise à jour de la [docu...(MOT_TRAIT_MOT)
src/content/docs/fr/plugins/extended.mdx (6)
7-9: Added “Mis à jour” badge for updated plugin example
This highlights that the extended plugin documentation has been refreshed for beta-18.
46-46: Define plugin options interface
Addingroute: string;toOptionscorrectly reflects the hook-based example’s API surface.
50-51: Implement path resolution comment and code
UsingcreateResolver(import.meta.url)to resolve the Astro component path is clear and idiomatic.
53-54: Introduce Astro integration function
Refactoring to amonIntegrationfunction that returns anAstroIntegrationmatches the new hook-based design.
55-81: Hook-driven integration logic is correct
The"astro:config:setup"hook injects the route and virtual imports as intended.
86-89: definePlugin call updated to hook-based API
Identifier, name, minimum version bump to0.1.0-beta.18, and hook registrations align with the redesigned plugin interface.src/content/docs/fr/plugins/index.mdx (3)
7-9: Added “Mis à jour” badge to core plugins page
This signals that the fundamental plugin docs now cover the new hook-based API in beta-18.
29-34: UpdatedStudioCMSPlugininterface withhooksproperty
Defining both'studiocms:astro:config'and'studiocms:config:setup'hooks ensures plugin authors can register integrations and configure site features.
107-114: Example plugin definition aligns with new interface
ThestudiocmsMinimumVersionbump and thehooksobject in the example correctly demonstrate the hook-based pattern.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
src/content/docs/fr/plugins/index.mdx (2)
108-114: Uniformiser le style des chaînes et terminer les instructions par un point-virgule
Il y a une légère incohérence de guillemets ('mon-module-extension'vs"Mon module d’extension") et l'appeladdIntegrations(monIntegration(options))pourrait se terminer par un point-virgule pour respecter les conventions du projet.
118-118: Alléger la phrase et corriger l'espacement
La phrase est longue et manque d’une espace après le point. Par exemple :- Dans cet exemple, nous définissons un module d’extension pour StudioCMS appelé `Mon module d’extension` qui nécessite la version `0.1.0-beta.18` ou supérieure de StudioCMS. + Dans cet exemple, nous définissons un module d’extension pour StudioCMS nommé `Mon module d’extension`. Ce module nécessite la version `0.1.0-beta.18` (ou supérieure) de StudioCMS.🧰 Tools
🪛 LanguageTool
[uncategorized] ~118-~118: 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: ...odule d’extension pour StudioCMS appeléMon module d’extensionqui nécessite la ve...(POINT_DET)
[typographical] ~118-~118: Une espace est requise.
Context: ...sage dans la console lorsque le crochetastro:config:setupest appelé. Pour plus ...(DEUX_POINTS_ESPACE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/content/docs/fr/plugins/index.mdx(3 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/fr/plugins/index.mdx
[uncategorized] ~118-~118: 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: ...odule d’extension pour StudioCMS appelé Mon module d’extension qui nécessite la ve...
(POINT_DET)
[typographical] ~118-~118: Une espace est requise.
Context: ...sage dans la console lorsque le crochet astro:config:setup est appelé. Pour plus ...
(DEUX_POINTS_ESPACE)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Run Starlight Link Check
🔇 Additional comments (2)
src/content/docs/fr/plugins/index.mdx (2)
7-9: Ajout du badge "Mis à jour"
Le badge est conforme aux directives de style et aide les utilisateurs à identifier rapidement les mises à jour de cette section.
24-73: Validation de la définition de l'interfaceStudioCMSPlugin
La nouvelle interface et la structurehookssont correctes et cohérentes avec le système de plugins décrit. La syntaxe TypeScript est valide et l’exemple couvre bien les deux hooks majeurs (studiocms:astro:configetstudiocms:config:setup).
3 participants
Description
Adds changes from #133 to the French translation.
Summary by CodeRabbit
New Features
Documentation