Skip to content

i18n(fr): update start-here#154

Merged
dreyfus92 merged 1 commit into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-start-here
Aug 6, 2025
Merged

i18n(fr): update start-here#154
dreyfus92 merged 1 commit into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-start-here

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Aug 6, 2025

Description

Adds changes from #150 and #151 to the French translations in start-here.

Summary by CodeRabbit

  • Documentation
    • Updated the French "Getting Started" guide with a new section on configuring rendering plugins, including sample configuration and links to the package catalog.
    • Revised the OAuth authentication section to clarify provider support via extension modules, added callback URL details, and marked the section with a revision badge.
    • Removed detailed OAuth environment variable instructions and badge metadata from related documentation pages for improved clarity and consistency.

@ArmandPhilippot ArmandPhilippot requested a review from a team as a code owner August 6, 2025 10:32
@netlify
Copy link
Copy Markdown

netlify Bot commented Aug 6, 2025

Deploy Preview for studiocms-dev-docs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit f4d9744
🔍 Latest deploy log https://app.netlify.com/projects/studiocms-dev-docs/deploys/68932f2864a1090008db80a3
😎 Deploy Preview https://deploy-preview-154--studiocms-dev-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@studiocms-no-reply
Copy link
Copy Markdown
Member

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/start-here/configuration.mdx Localization changed, will be marked as complete.
fr/start-here/environment-variables.mdx Localization changed, will be marked as complete.
fr/start-here/getting-started.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.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Aug 6, 2025

Walkthrough

This update modifies French documentation files for StudioCMS. It removes the "badge" property from the sidebar configuration in two files and adds it to another. The "getting started" guide is expanded with new configuration instructions and revised OAuth authentication guidance, while OAuth environment variable details are removed from the environment variables documentation.

Changes

Cohort / File(s) Change Summary
Sidebar Badge Removal
src/content/docs/fr/start-here/configuration.mdx, src/content/docs/fr/start-here/environment-variables.mdx
Removed the badge property from the sidebar frontmatter in both documentation files.
Getting Started Guide Enhancements
src/content/docs/fr/start-here/getting-started.mdx
Added a "Mis à jour" badge to the sidebar, imported the Badge component, introduced a section on configuring rendering plugins, revised OAuth setup instructions to be more general, and removed explicit OAuth environment variable details and provider mentions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docs ("Getting Started Doc")
    participant Plugins ("Rendering Plugins")
    participant OAuth ("OAuth Extensions")

    User->>Docs: Read setup instructions
    Docs->>User: Show badge, rendering plugin info
    User->>Plugins: Install & configure rendering plugin
    User->>OAuth: (Optional) Find/install OAuth extension
    OAuth->>User: Provide setup & callback URL info
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested reviewers

  • dreyfus92

Poem

A badge hops out, another hops in,
Docs refreshed with a rabbit’s grin.
OAuth’s now a broader tale,
Plugins guide you down the trail.
In French we leap, with docs anew—
Hippity-hop, this update’s for you!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
src/content/docs/fr/start-here/getting-started.mdx (3)

224-233: Liste d’extensions : améliorer la typographie et la lisibilité
Les puces combinent un tiret et une em-dash (“- … - …”), ce qui déclenche plusieurs alertes LanguageTool et nuit à la clarté. Une formulation plus concise et idiomatique :

- - `@studiocms/html` - pour le rendu HTML
- - `@studiocms/md` - pour le rendu Markdown
- - `@studiocms/mdx` - pour le rendu MDX
- - `@studiocms/markdoc` - pour le rendu MarkDoc
- - Ou tout autre module d’extension communautaire prenant en charge le rendu de contenu dans StudioCMS.
+ - `@studiocms/html` : rendu HTML
+ - `@studiocms/md` : rendu Markdown
+ - `@studiocms/mdx` : rendu MDX
+ - `@studiocms/markdoc` : rendu Markdoc
+ - ou tout module communautaire compatible avec le rendu StudioCMS.

Cela supprime les doubles tirets, ajoute des deux-points après le paquet et harmonise la casse.


247-247: Ponctuation manquante dans la balise ReadMore
Terminer la phrase par un point évite l’avertissement LanguageTool et reste cohérent avec les autres encarts.

-<ReadMore>Pour plus d’informations sur les modules d’extension de rendu disponibles, consultez le [catalogue des paquets][package-catalog]</ReadMore>
+<ReadMore>Pour plus d’informations sur les modules d’extension de rendu disponibles, consultez le [catalogue des paquets][package-catalog].</ReadMore>

272-276: Section oAuth : fluidité et ponctuation
Deux alertes : phrase longue avec “en utilisant”, et absence de point final. Proposition :

-StudioCMS prend en charge divers fournisseurs d’authentification oAuth, en utilisant notre système de modules d’extension pour activer les fournisseurs que vous souhaitez utiliser. Pour commencer, vous devrez trouver un module d’extension pour le fournisseur que vous souhaitez utiliser ou créer votre propre module d’extension.
+StudioCMS prend en charge plusieurs fournisseurs oAuth grâce à son système de modules d’extension. Sélectionnez le plugin correspondant au fournisseur voulu, ou créez le vôtre si nécessaire.

Plus direct, évite la répétition de “utiliser” et clôt la phrase.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 21b126c and f4d9744.

📒 Files selected for processing (3)
  • src/content/docs/fr/start-here/configuration.mdx (0 hunks)
  • src/content/docs/fr/start-here/environment-variables.mdx (0 hunks)
  • src/content/docs/fr/start-here/getting-started.mdx (3 hunks)
💤 Files with no reviewable changes (2)
  • src/content/docs/fr/start-here/configuration.mdx
  • src/content/docs/fr/start-here/environment-variables.mdx
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#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
PR: withstudiocms/docs#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
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.
📚 Learning: in the withstudiocms/docs repository, documentation urls in the package-catalog may maintain legacy ...
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.

Applied to files:

  • src/content/docs/fr/start-here/getting-started.mdx
📚 Learning: in the withstudiocms/docs repository, when reviewing french translation files, maintain consistency ...
Learnt from: ArmandPhilippot
PR: withstudiocms/docs#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.

Applied to files:

  • src/content/docs/fr/start-here/getting-started.mdx
🪛 LanguageTool
src/content/docs/fr/start-here/getting-started.mdx

[uncategorized] ~13-13: Le point-virgule est précédé d’une espace fine insécable.
Context: ...rsoCLI from '
/components/TursoCLI.astro'; import { Aside, Steps, Tabs, TabItem, L...

(FRENCH_WHITESPACE)


[uncategorized] ~14-14: Le point-virgule est précédé d’une espace fine insécable.
Context: ...ge } from '@astrojs/starlight/components'; import ReadMore from '
/components/Read...

(FRENCH_WHITESPACE)


[typographical] ~226-~226: Cette phrase doit commencer par un tiret et une majuscule.
Context: ...projet StudioCMS : - @studiocms/html - pour le rendu HTML - @studiocms/md - pour ...

(TIRET)


[typographical] ~227-~227: Le trait d’union est employé sans espace pour former des mots, alors que le tiret est encadré par des espaces et placé entre deux mots distincts.
Context: ... - pour le rendu HTML - @studiocms/md - pour le rendu Markdown - `@studiocms/md...

(TIRET)


[typographical] ~228-~228: Le trait d’union est employé sans espace pour former des mots, alors que le tiret est encadré par des espaces et placé entre deux mots distincts.
Context: ...ur le rendu Markdown - @studiocms/mdx - pour le rendu MDX - `@studiocms/markdoc...

(TIRET)


[typographical] ~229-~229: Le trait d’union est employé sans espace pour former des mots, alors que le tiret est encadré par des espaces et placé entre deux mots distincts.
Context: ...our le rendu MDX - @studiocms/markdoc - pour le rendu MarkDoc - Ou tout autre m...

(TIRET)


[uncategorized] ~247-~247: S’il s’agit d’un impératif, mettez un trait d’union.
Context: ...dules d’extension de rendu disponibles, consultez le [catalogue des paquets][package-catalog...

(grammalecte_gv1__imp_union_le_la_leur__b1_a1_1)


[uncategorized] ~247-~247: Le trait d’union doit être supprimé.
Context: ...s, consultez le [catalogue des paquets][package-catalog] ## Configurer l’authentifi...

(MOT_TRAIT_MOT)


[uncategorized] ~247-~247: Un point est requis pour indiquer la fin de cette phrase.
Context: ... [catalogue des paquets][package-catalog] ## Configurer l’authentific...

(POINT)


[style] ~274-~274: Une autre structure plus directe dynamisera votre phrase.
Context: ... fournisseurs d’authentification oAuth, en utilisant notre système de modules d’extension po...

(EN_UTILISANT)


[style] ~274-~274: Dans un contexte formel des synonymes peuvent enrichir votre style.
Context: ...’extension pour le fournisseur que vous souhaitez utiliser ou créer votre propre module d...

(REP_SOUHAITER)


[uncategorized] ~276-~276: S’il s’agit d’un impératif, mettez un trait d’union.
Context: ...n d’authentification oAuth disponibles, consultez le [catalogue des paquets][package-catalog...

(grammalecte_gv1__imp_union_le_la_leur__b1_a1_1)


[uncategorized] ~276-~276: Le trait d’union doit être supprimé.
Context: ...s, consultez le [catalogue des paquets][package-catalog] Pour configurer les fourni...

(MOT_TRAIT_MOT)


[uncategorized] ~276-~276: Un point est requis pour indiquer la fin de cette phrase.
Context: ... [catalogue des paquets][package-catalog] Pour configurer les fournis...

(POINT)

⏰ 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). (4)
  • GitHub Check: Redirect rules - studiocms-dev-docs
  • GitHub Check: Header rules - studiocms-dev-docs
  • GitHub Check: Pages changed - studiocms-dev-docs
  • GitHub Check: Run Starlight Link Check
🔇 Additional comments (3)
src/content/docs/fr/start-here/getting-started.mdx (3)

7-9: Ajout du badge “Mis à jour” approuvé
La propriété badge aligne la navigation française sur l’originale. Rien à redire.


14-14: Import de Badge cohérent
L’import est nécessaire pour le composant utilisé plus bas (ligne 222). Conforme au pattern des autres fichiers.


234-245: Bloc de configuration valide
Le snippet studiocms.config.mjs est correct, respecte la signature des plugins et garde la parité avec la version anglaise.

Copy link
Copy Markdown
Member

@dreyfus92 dreyfus92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merci @ArmandPhilippot, LGTM ✅

@dreyfus92 dreyfus92 merged commit c2dbb5a into withstudiocms:main Aug 6, 2025
12 checks passed
@ArmandPhilippot ArmandPhilippot deleted the i18n/fr-update-start-here branch August 6, 2025 19:35
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