i18n(fr): update how-it-works#183
Conversation
📝 WalkthroughWalkthroughFrench documentation for how StudioCMS works has been updated: badges added to sidebar metadata, Astro DB references removed from descriptions, and SDK public API documentation revised to reflect new exports (dbService, cache, AUTH, CONFIG, and others replacing db). Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
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: 1
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
src/content/docs/fr/how-it-works/index.mdx(1 hunks)src/content/docs/fr/how-it-works/restapi.mdx(1 hunks)src/content/docs/fr/how-it-works/sdk.mdx(2 hunks)
🧰 Additional context used
🧠 Learnings (1)
📓 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.
Learnt from: ArmandPhilippot
Repo: withstudiocms/docs 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.
Learnt from: ArmandPhilippot
Repo: withstudiocms/docs 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/restapi.mdx
[style] ~11-~11: Ce verbe peut être considéré comme familier dans un contexte formel.
Context: ...le offre un moyen simple et flexible de gérer et de diffuser votre contenu. L’API RE...
(VERBES_FAMILIERS_PREMIUM)
src/content/docs/fr/how-it-works/index.mdx
[style] ~14-~14: Ce verbe peut être considéré comme familier dans un contexte formel.
Context: ...ant conçu pour Astro qui vous permet de gérer et de diffuser votre contenu. Il est co...
(VERBES_FAMILIERS_PREMIUM)
[style] ~14-~14: Ce verbe peut être considéré comme familier dans un contexte formel.
Context: ... utiliser et suffisamment flexible pour gérer tout type de contenu. Étendre StudioCM...
(VERBES_FAMILIERS_PREMIUM)
src/content/docs/fr/how-it-works/sdk.mdx
[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 notre pro...
(VERBES_FAMILIERS_PREMIUM)
[style] ~14-~14: Cette structure peut être modifiée afin de devenir plus percutante.
Context: ...r votre contenu via notre propre client de base de données interne [Kysely](https://kys...
(DE_BASE3)
[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)
⏰ 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: build-and-push
- GitHub Check: Run Starlight Link Check
🔇 Additional comments (6)
src/content/docs/fr/how-it-works/index.mdx (2)
6-9: LGTM! Badge addition is properly formatted.The "Mis à jour" badge with success variant is correctly added with proper YAML indentation.
14-18: LGTM! Translation updates align with PR objectives.The revised descriptions successfully remove Astro DB references while maintaining clear and accurate French technical documentation. The text flows naturally and preserves the intended meaning.
Note: The static analysis hints flagging "gérer" as informal are false positives—this verb is perfectly appropriate in French technical documentation.
src/content/docs/fr/how-it-works/sdk.mdx (3)
6-9: LGTM! Badge addition is consistent and properly formatted.The "Mis à jour" badge matches the pattern used in
index.mdxand follows correct YAML formatting.
14-14: LGTM! Documentation updated to reflect Kysely-based client.The description accurately reflects the shift from Astro DB to an internal Kysely-based database client, aligning with the broader API refactor documented in this PR.
52-70: LGTM! API surface changes properly documented.The destructuring update accurately reflects the public API refactor:
- Removed:
db- Added:
dbService,cache,AUTH,CONFIG,diffTracking,MIDDLEWARES,notificationSettings,PLUGINS,resetTokenBucket,UTILThis documents a significant shift in the SDK's public interface.
src/content/docs/fr/how-it-works/restapi.mdx (1)
11-11: Translation maintains correct parity with English source.The French
restapi.mdxcorrectly lacks a badge because its English counterpart also does not have one. Bothindex.mdxandsdk.mdx(in English and French) consistently include the "Updated" / "Mis à jour" badge. The file structure is consistent with the source material.
| ## Lectures complémentaires | ||
|
|
||
| <ReadMore> | ||
| Le SDK de StudioCMS est alimenté par le [paquet `@withstudiocms/sdk`](/fr/utils/kysely-and-sdk/#le-paquet-sdk), qui fournit des fonctionnalités et des utilitaires supplémentaires pour travailler avec StudioCMS. Pour plus d'informations, consultez la [documentation de Kysely et du SDK](/fr/utils/kysely-and-sdk/). | ||
| </ReadMore> |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify the referenced path exists in the French documentation
# Check if the Kysely and SDK documentation exists in French
echo "=== Searching for kysely-and-sdk in French docs ==="
fd -t f "kysely-and-sdk" src/content/docs/fr
echo -e "\n=== Checking utils directory structure ==="
fd -t d -d 3 "utils" src/content/docs/fr
echo -e "\n=== Checking if utils directory exists and listing contents ==="
if [ -d "src/content/docs/fr/utils" ]; then
find src/content/docs/fr/utils -type f -name "*.mdx" | head -20
fiRepository: withstudiocms/docs
Length of output: 289
🏁 Script executed:
#!/bin/bash
# Search for Kysely and SDK documentation in the entire docs structure
echo "=== Searching for any Kysely references ==="
fd -t f "kysely" src/content/docs
echo -e "\n=== Checking English utils directory ==="
fd -t f . src/content/docs/en/utils/ 2>/dev/null || echo "English utils directory contents check"
echo -e "\n=== Searching for SDK references in French docs ==="
rg "kysely\|sdk" src/content/docs/fr --type mdx -lRepository: withstudiocms/docs
Length of output: 379
🏁 Script executed:
#!/bin/bash
# Let's also check if there's a pattern for French translations of English docs
echo "=== List all French utils docs ==="
ls -la src/content/docs/fr/utils/ 2>/dev/null || echo "Directory structure"
echo -e "\n=== List all English utils docs ==="
ls -la src/content/docs/en/utils/ 2>/dev/null || echo "Directory structure"
echo -e "\n=== Check if the file is referenced elsewhere ==="
rg "kysely-and-sdk" src/content/docs --no-textRepository: withstudiocms/docs
Length of output: 1293
The referenced path /fr/utils/kysely-and-sdk/ does not exist and will result in broken links.
The French documentation at src/content/docs/fr/utils/ only contains rendering.mdx. The Kysely and SDK documentation currently exists only in English at /en/utils/kysely-and-sdk/. Either translate the documentation to French or link to the English version using /en/utils/kysely-and-sdk/ instead.
🤖 Prompt for AI Agents
In src/content/docs/fr/how-it-works/sdk.mdx around lines 73 to 77, the link
targets /fr/utils/kysely-and-sdk/ which does not exist and will create broken
links; update the link to point to the existing English page
/en/utils/kysely-and-sdk/ (or add/translate the corresponding French page under
src/content/docs/fr/utils/kysely-and-sdk.mdx and adjust the path accordingly)
and ensure the ReadMore block and any surrounding references use the corrected
path.
3 participants
Description
Adds changes from #177 to the French translations in
how-it-works(exceptcli.mdxalready updated in #178)Note
The failing slug should be resolved once #182 is merged.
Summary by CodeRabbit
Documentation
Features
✏️ Tip: You can customize this high-level summary in your review settings.