i18n(fr): update how-it-works#141
Conversation
WalkthroughThis update modifies the French documentation for StudioCMS. It removes outdated CLI options, adds a new page about the Effect library, streamlines SDK usage documentation, and updates module listings and metadata in the "how-it-works" section. The changes focus on improving clarity and reflecting current features. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant StudioCMS
User->>Docs: Reads updated SDK usage
Docs->>User: Shows Effect-based SDK example
User->>StudioCMS: Imports SDKCoreJs, runSDK, Effect
User->>StudioCMS: Runs async SDK call via Effect
StudioCMS-->>User: Returns result
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
🧹 Nitpick comments (2)
src/content/docs/fr/how-it-works/index.mdx (1)
26-30: Valider la consolidation du sous-module d’authentification et les nouvelles entrées
- Le passage de plusieurs sous-modules (
utils/*) à un seulstudiocms:auth/libdans l’anglais source supprime-t-il réellement les import utilisables ?- Vérifier que
studiocms:auth/utils/validImagesetstudiocms:auth/scripts/threeexistent bien côté build – ils n’apparaissent pas dans la version anglaise stable 🤔.- Formulation : « Utilitaires d’authentification pour StudioCMS » est redondant avec le contexte ; une version plus concise serait « Utilitaires d’authentification ».
- **`studiocms:auth/lib`** : Utilitaires d’authentification pour StudioCMS. + **`studiocms:auth/lib`** : Utilitaires d’authentification.src/content/docs/fr/how-it-works/sdk.mdx (1)
47-64: Liste utilitaires : ordre et exhaustivitéLa destructuration mélange verbes (CLEAR, DELETE…) et namespaces (
db,REST_API). Pour gagner en lisibilité :
- regrouper par catégorie (DB, REST, CRUD, services) ou
- conserver l’ordre alphabétique comme dans l’anglais.
Pas bloquant mais améliore la consultation.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
src/content/docs/fr/how-it-works/cli.mdx(0 hunks)src/content/docs/fr/how-it-works/effect.mdx(1 hunks)src/content/docs/fr/how-it-works/index.mdx(2 hunks)src/content/docs/fr/how-it-works/sdk.mdx(1 hunks)
💤 Files with no reviewable changes (1)
- src/content/docs/fr/how-it-works/cli.mdx
🧰 Additional context used
🧠 Learnings (3)
📓 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/how-it-works/index.mdx (2)
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.
Learnt from: ArmandPhilippot
PR: #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.
src/content/docs/fr/how-it-works/sdk.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.
🪛 LanguageTool
src/content/docs/fr/how-it-works/effect.mdx
[uncategorized] ~12-12: Le point-virgule est précédé d’une espace fine insécable./components/ReadMore.astro'; # Introduction Si vous n’en avez jama...
Context: ...adMore from '
(FRENCH_WHITESPACE)
[style] ~18-~18: Ce verbe peut être considéré comme familier dans un contexte formel.
Context: ...chrones. StudioCMS utilise Effect pour gérer la majeure partie de notre code, ce qui...
(VERBES_FAMILIERS_PREMIUM)
[style] ~28-~28: Cette structure peut être modifiée afin de devenir plus percutante.
Context: ...nclut exactement les mêmes exportations de base que l’exportation par défaut d’Effect `...
(DE_BASE3)
src/content/docs/fr/how-it-works/index.mdx
[style] ~27-~27: Dans un contexte formel des synonymes peuvent enrichir votre style.
Context: ...uth/utils/authEnvCheck`** : Utilitaires permettant de vérifier l’environnement d’authentifica...
(REP_PERMETTRE)
[style] ~28-~28: Dans un contexte formel des synonymes peuvent enrichir votre style.
Context: ...abelForPermissionLevel`** : Utilitaires permettant d’obtenir l’étiquette d’un niveau d’autori...
(REP_PERMETTRE)
src/content/docs/fr/how-it-works/sdk.mdx
[uncategorized] ~12-12: Le point-virgule est précédé d’une espace fine insécable./components/ReadMore.astro'; Le SDK de StudioCMS est un outil puiss...
Context: ...adMore from '
(FRENCH_WHITESPACE)
[style] ~14-~14: Ce verbe peut être considéré comme familier dans un contexte formel.
Context: ...mble de fonctions et d’utilitaires pour gérer et diffuser votre contenu via Astro DB....
(VERBES_FAMILIERS_PREMIUM)
[style] ~14-~14: Utilisé hors du contexte militaire, on préfèrera d’autres tournures à « baser sur ».
Context: ...ase du tableau de bord StudioCMS et est basé sur Effect. ## U...
(BASER_SUR)
[style] ~16-~16: Cette structure peut être modifiée afin de devenir plus percutante.
Context: ...ttps://effect.website). ## Utilisation de base Le SDK de StudioCMS est disponible sou...
(DE_BASE3)
⏰ 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
🔇 Additional comments (6)
src/content/docs/fr/how-it-works/index.mdx (1)
7-9: Sidebar badge : rien à redire
La métadonnée « Mis à jour » + variantsuccessest cohérente avec la taxonomie interne du site.src/content/docs/fr/how-it-works/effect.mdx (2)
1-9: Front-matter OK
Les champsi18nReady,badgeet l’ordre de sidebar sont conformes aux conventions existantes.
22-36: Confirmer le nom du module virtuel “effect” et la disponibilité des utilitaires personnalisés
- Le reste de la doc emploie la convention
studiocms:xxx. Ici l’exemple utilisestudiocms/effect(slash).
‑ Est-ce réellement l’alias exposé par l’intégration ?- Les helpers
convertToVanilla,errorTap, etc. sont listés mais n’apparaissent pas côté anglais ; assurez-vous qu’ils sont bien exportés pour éviter aux lecteurs un ImportError.Si la bonne specifier est avec
:, appliquer :-import { Effect, Context, Schema, Data } from 'studiocms/effect'; +import { Effect, Context, Schema, Data } from 'studiocms:effect';src/content/docs/fr/how-it-works/sdk.mdx (3)
7-9: Badge mis à jour : rien à signaler
18-25: Nom des modules virtuels : double convention://à éclaircirOn importe ici :
import { SDKCore, SDKCoreJs, runSDK } from 'studiocms:sdk'; import { Effect } from 'studiocms/effect';Même remarque que pour
effect.mdx: assurez-vous que les deux styles (:vs/) sont exacts et documentés ; sinon les lecteurs rencontreront des erreurs Vite.
27-34:SDKCore.Defaultexiste-t-il vraiment ?L’API courante expose souvent
SDKCoreLiveou simplement un layer à fournir. Merci de valider queDefaultest le bon export ; sinon l’exemple échouera.
3 participants
Description
Adds changes from #139 to the French translation of
how-it-works:cli.mdx,index.mdxandsdk.mdxeffect.mdxSummary by CodeRabbit
New Features
Documentation
--colorand--no-coloroptions.