Skip to content

i18n(fr): update package-catalog#157

Merged
dreyfus92 merged 1 commit into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-package-catalog
Aug 7, 2025
Merged

i18n(fr): update package-catalog#157
dreyfus92 merged 1 commit into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-package-catalog

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Aug 7, 2025

Description

Adds changes from #150 and #151 to the French translations of packages-catalog:

  • update studiocms-blog.mdx, studiocms-markdoc.mdx and studiocms-mdx.mdx
  • translate studiocms-auth0.mdx, studiocms-discord.mdx, studiocms-github.mdx, studiocms-google.mdx, studiocms-html.mdx and studiocms-md.mdx

I know this looks like a lot but most are short and very similar so I think they will be quick to review. 😅 But if you prefer, I can split next time!

Summary by CodeRabbit

  • Documentation
    • Added new French documentation for StudioCMS plugins: Auth0, Discord, GitHub, Google, HTML, and Markdown support modules, including setup instructions and required environment variables.
    • Updated documentation for Blog, Markdoc, and MDX plugins to include notes about required dependencies.

@ArmandPhilippot ArmandPhilippot requested a review from a team as a code owner August 7, 2025 16:41
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Aug 7, 2025

Walkthrough

This update introduces new French documentation files for several StudioCMS plugins, including OAuth providers (Auth0, Discord, GitHub, Google), Markdown/MDX/Markdoc/HTML support, and updates to existing docs to clarify extension dependencies. Most changes add usage instructions, configuration examples, and required environment variables.

Changes

Cohort / File(s) Change Summary
New OAuth Provider Plugin Docs
.../studiocms-auth0.mdx, .../studiocms-discord.mdx, .../studiocms-github.mdx, .../studiocms-google.mdx
Added new documentation files for Auth0, Discord, GitHub, and Google OAuth provider plugins. Each file describes the plugin, setup instructions, required environment variables, and configuration steps for enabling OAuth authentication in StudioCMS.
New Markdown/HTML Plugin Docs
.../studiocms-html.mdx, .../studiocms-md.mdx
Added new documentation for HTML and Markdown integration plugins. These docs include installation instructions, configuration options, and detailed descriptions of plugin features and TypeScript interfaces.
Dependency Notice Updates
.../studiocms-blog.mdx, .../studiocms-markdoc.mdx, .../studiocms-mdx.mdx
Updated import statements to include the Aside component. Added <Aside> blocks to clarify that these extensions require the @studiocms/md extension module. No other content changes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant StudioCMS Docs
    User->>StudioCMS Docs: Access plugin documentation
    StudioCMS Docs->>User: Show setup instructions, config, and env vars
    User->>StudioCMS Docs: Follow steps to configure plugin
    StudioCMS Docs->>User: Provide dependency and usage notes
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

  • i18n(fr): update plugins and utils #156: Updates the plugin interface to include a method for OAuth provider configuration, directly related to the authentication service setup described in these new docs.
  • Beta.23 #151: Adds these OAuth provider plugins to the documentation sidebar and package catalog, directly relating to the same plugins and their documentation integration.

Suggested labels

i18n

Suggested reviewers

  • dreyfus92

Poem

In the docs a bunny hops,
Adding OAuth tips and plugin props.
Markdown, HTML, and more to see,
With Asides for dependency!
From Auth0 to Google—so much in store,
StudioCMS grows, and bunnies adore.
🐇✨

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.

@netlify
Copy link
Copy Markdown

netlify Bot commented Aug 7, 2025

Deploy Preview for studiocms-dev-docs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit bee55f4
🔍 Latest deploy log https://app.netlify.com/projects/studiocms-dev-docs/deploys/6894d740b3157e0008d5ed91
😎 Deploy Preview https://deploy-preview-157--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/package-catalog/studiocms-plugins/studiocms-auth0.mdx Localization added, will be marked as complete.
fr/package-catalog/studiocms-plugins/studiocms-blog.mdx Localization changed, will be marked as complete.
fr/package-catalog/studiocms-plugins/studiocms-discord.mdx Localization added, will be marked as complete.
fr/package-catalog/studiocms-plugins/studiocms-github.mdx Localization added, will be marked as complete.
fr/package-catalog/studiocms-plugins/studiocms-google.mdx Localization added, will be marked as complete.
fr/package-catalog/studiocms-plugins/studiocms-html.mdx Localization added, will be marked as complete.
fr/package-catalog/studiocms-plugins/studiocms-markdoc.mdx Localization changed, will be marked as complete.
fr/package-catalog/studiocms-plugins/studiocms-md.mdx Localization added, will be marked as complete.
fr/package-catalog/studiocms-plugins/studiocms-mdx.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.

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 (13)
src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-github.mdx (2)

13-14: Remove unnecessary NBSP before the semicolon.

The thin non-breaking space just before ; trips some linters/formatters and is unnecessary.

-import { PackageManagers } from 'starlight-package-managers'
-import { Steps, Tabs, TabItem, Aside } from '@astrojs/starlight/components';
+import { PackageManagers } from 'starlight-package-managers'
+import { Steps, Tabs, TabItem, Aside } from '@astrojs/starlight/components';

18-30: Add an installation snippet for parity with other plugin docs.

Most plugin pages include a <PackageManagers> or npm/pnpm command before the configuration code. Including it keeps the French docs structurally aligned with the English originals and avoids readers wondering how to install the package.

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-discord.mdx (2)

13-14: Unneeded thin space before semicolon.

Same stylistic issue as in the GitHub page; consider removing the before ; to appease formatters.


18-30: Include an install command for consistency.

Adding a <PackageManagers> block (or an npm i @studiocms/discord example) keeps this page consistent with other catalog entries.

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-google.mdx (2)

13-14: Thin space before semicolon—minor cleanup.

As with the other files, drop the fine NBSP before ; to avoid linter noise.


18-30: Consider adding an installation block.

A short install command (or <PackageManagers>) would align this page with the rest of the catalog.

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-auth0.mdx (2)

13-14: Minor formatting: remove thin space before semicolon.

Same comment as above; tiny but keeps formatting tools happy.


18-30: Add an installation example for completeness.

Including a <PackageManagers> block or npm i @studiocms/auth0 mirrors other docs and helps newcomers.

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-markdoc.mdx (1)

14-14: Tiny formatting nit: extra NBSP before semicolon.

Removing the fine non-breaking space keeps import lines uniform with other docs.

-import { Steps, Tabs, TabItem, Aside } from '@astrojs/starlight/components';
+import { Steps, Tabs, TabItem, Aside } from '@astrojs/starlight/components';
src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-blog.mdx (1)

14-14: Replace narrow no-break space before ; with a regular space

The space just before the semicolon is a Unicode U+202F (narrow no-break space).
Although ECMAScript treats it as whitespace, keeping only ASCII spaces in import
statements avoids invisible-character issues when copying or linting.

-import { Steps, Tabs, TabItem, Aside } from '@astrojs/starlight/components’;
+import { Steps, Tabs, TabItem, Aside } from '@astrojs/starlight/components';
src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-mdx.mdx (1)

14-14: Replace narrow no-break space before ; with a regular space

Same invisible U+202F character as in the Blog doc; swap it for a normal
space to avoid hidden-char lint warnings.

-import { Steps, Tabs, TabItem, Aside } from '@astrojs/starlight/components’;
+import { Steps, Tabs, TabItem, Aside } from '@astrojs/starlight/components';
src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-html.mdx (1)

14-14: Swap the narrow no-break space for a normal space

A U+202F sneaked in before the semicolon; replace with an ASCII space.

-import { Steps, Tabs, TabItem } from '@astrojs/starlight/components’;
+import { Steps, Tabs, TabItem } from '@astrojs/starlight/components';
src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-md.mdx (1)

14-14: Normalise whitespace in the import line

Same remark as above: remove the U+202F narrow no-break space before the
semicolon.

-import { Steps, Tabs, TabItem } from '@astrojs/starlight/components’;
+import { Steps, Tabs, TabItem } from '@astrojs/starlight/components';
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 98afceb and bee55f4.

📒 Files selected for processing (9)
  • src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-auth0.mdx (1 hunks)
  • src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-blog.mdx (1 hunks)
  • src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-discord.mdx (1 hunks)
  • src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-github.mdx (1 hunks)
  • src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-google.mdx (1 hunks)
  • src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-html.mdx (1 hunks)
  • src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-markdoc.mdx (1 hunks)
  • src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-md.mdx (1 hunks)
  • src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-mdx.mdx (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 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: 2025-07-21T12:16:32.374Z
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/package-catalog/studiocms-plugins/studiocms-markdoc.mdx
  • src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-github.mdx
  • src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-html.mdx
  • src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-md.mdx
🪛 LanguageTool
src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-blog.mdx

[uncategorized] ~14-~14: Le point-virgule est précédé d’une espace fine insécable.
Context: ...de } from '@astrojs/starlight/components'; Ce module d’extension active les fonct...

(FRENCH_WHITESPACE)

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-markdoc.mdx

[uncategorized] ~14-~14: Le point-virgule est précédé d’une espace fine insécable.
Context: ...de } from '@astrojs/starlight/components'; # Présentation Ce module d’extension ...

(FRENCH_WHITESPACE)

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-mdx.mdx

[uncategorized] ~14-~14: Le point-virgule est précédé d’une espace fine insécable.
Context: ...de } from '@astrojs/starlight/components'; # Présentation Ce module d’extension ...

(FRENCH_WHITESPACE)

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-discord.mdx

[uncategorized] ~14-~14: Le point-virgule est précédé d’une espace fine insécable.
Context: ...de } from '@astrojs/starlight/components'; Ce module d’extension intègre Discord ...

(FRENCH_WHITESPACE)


[style] ~16-~16: Une autre expression peut sembler plus percutante.
Context: ... Ce module d’extension intègre Discord en tant que fournisseur d’authentification OAuth po...

(EN_TANT_QUE1)


[typographical] ~20-~20: Caractère d’apostrophe incorrect.
Context: ... dans votre configuration de StudioCMS. (studiocms.config.mjs) ```ts title="stu...

(APOS_INCORRECT)

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-github.mdx

[uncategorized] ~14-~14: Le point-virgule est précédé d’une espace fine insécable.
Context: ...de } from '@astrojs/starlight/components'; Ce module d’extension intègre GitHub e...

(FRENCH_WHITESPACE)


[style] ~16-~16: Une autre expression peut sembler plus percutante.
Context: ...; Ce module d’extension intègre GitHub en tant que fournisseur d’authentification OAuth po...

(EN_TANT_QUE1)


[typographical] ~20-~20: Caractère d’apostrophe incorrect.
Context: ... dans votre configuration de StudioCMS. (studiocms.config.mjs) ```ts title="stu...

(APOS_INCORRECT)

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-html.mdx

[uncategorized] ~14-~14: Le point-virgule est précédé d’une espace fine insécable.
Context: ...em } from '@astrojs/starlight/components'; # Présentation Ce module d’extension ...

(FRENCH_WHITESPACE)

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-google.mdx

[uncategorized] ~14-~14: Le point-virgule est précédé d’une espace fine insécable.
Context: ...de } from '@astrojs/starlight/components'; Ce module d’extension intègre l’authen...

(FRENCH_WHITESPACE)


[typographical] ~20-~20: Caractère d’apostrophe incorrect.
Context: ... dans votre configuration de StudioCMS. (studiocms.config.mjs) ```ts title="stu...

(APOS_INCORRECT)

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-auth0.mdx

[uncategorized] ~14-~14: Le point-virgule est précédé d’une espace fine insécable.
Context: ...de } from '@astrojs/starlight/components'; Ce module d’extension intègre Auth0 en...

(FRENCH_WHITESPACE)


[style] ~16-~16: Une autre expression peut sembler plus percutante.
Context: ...'; Ce module d’extension intègre Auth0 en tant que fournisseur OAuth pour StudioCMS, perme...

(EN_TANT_QUE1)


[typographical] ~20-~20: Caractère d’apostrophe incorrect.
Context: ... dans votre configuration de StudioCMS. (studiocms.config.mjs) ```ts title="stu...

(APOS_INCORRECT)

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-md.mdx

[uncategorized] ~14-~14: Le point-virgule est précédé d’une espace fine insécable.
Context: ...em } from '@astrojs/starlight/components'; # Présentation Ce module d’extension ...

(FRENCH_WHITESPACE)

⏰ 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 (7)
src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-github.mdx (1)

32-38: Confirm environment-variable prefixes match the actual package.

Double-check that the plugin expects the CMS_GITHUB_* variables (and not e.g. STUDIOCMS_GITHUB_* or GITHUB_OAUTH_*). Mismatched prefixes will cause silent auth failures.

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-discord.mdx (1)

32-38: Validate the expected env-var names.

Please verify the CMS_DISCORD_* names against the plugin source / English doc so readers don’t end up with incorrect variables.

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-google.mdx (1)

32-38: Re-check env-var naming for Google.

Ensure CMS_GOOGLE_* is what the plugin actually reads; otherwise users will be puzzled when OAuth fails.

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-auth0.mdx (1)

32-38: Verify Auth0 env-var set matches the code.

Confirm that the plugin expects exactly the four variables listed here (and the given prefixes). If it uses different keys (e.g., AUTH0_CLIENT_ID), update accordingly.

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-markdoc.mdx (1)

20-22: LGTM – clear dependency notice added.

The new <Aside> block cleanly states the @studiocms/md requirement and matches the English doc. No further action needed.

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-blog.mdx (1)

18-20: Nice addition clarifying the dependency

The <Aside> block makes the MD plugin requirement explicit for readers. 👍

src/content/docs/fr/package-catalog/studiocms-plugins/studiocms-mdx.mdx (1)

20-22: Dependency note adds valuable context

Good call adding the <Aside> to point to @studiocms/md.

@dreyfus92 dreyfus92 merged commit ecd4eca into withstudiocms:main Aug 7, 2025
12 checks passed
@ArmandPhilippot ArmandPhilippot deleted the i18n/fr-update-package-catalog branch August 7, 2025 20:38
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