Skip to content

i18n(fr): update config-reference#153

Merged
dreyfus92 merged 2 commits into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-config-reference
Aug 5, 2025
Merged

i18n(fr): update config-reference#153
dreyfus92 merged 2 commits into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-config-reference

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Aug 5, 2025

Description

Adds changes from #150 and #151 to the French translations in config-reference.

Summary by CodeRabbit

  • Documentation
    • Removed detailed configuration options and examples for pageTypeOptions and rendering engines from the French documentation.
    • Simplified the list of authentication providers in the documentation to only include usernameAndPassword.
    • Removed "badge" properties from the sidebar configuration in relevant French documentation pages.

@ArmandPhilippot ArmandPhilippot requested a review from a team as a code owner August 5, 2025 12:18
@netlify
Copy link
Copy Markdown

netlify Bot commented Aug 5, 2025

‼️ Deploy request for studiocms-dev-docs rejected.

Name Link
🔨 Latest commit 2c621c0

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Aug 5, 2025

Walkthrough

This update simplifies the French configuration documentation by removing detailed sections on pageTypeOptions, reducing the list of authentication providers to only usernameAndPassword, and deleting all sidebar badge metadata from the frontmatter of affected files. No changes are made to code or exported entities.

Changes

Cohort / File(s) Change Summary
Remove pageTypeOptions and auth providers
src/content/docs/fr/config-reference/features.mdx
Removed documentation for pageTypeOptions, Markdown/HTML renderer options, and reduced auth provider examples to only usernameAndPassword.
Remove sidebar badge metadata
src/content/docs/fr/config-reference/index.mdx, src/content/docs/fr/config-reference/locale.mdx
Deleted the "badge" property from the sidebar configuration in the frontmatter of both files.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested labels

i18n

Suggested reviewers

  • louisescher
  • dreyfus92

Poem

A bunny hopped through docs so neat,
Trimming badges, making them petite.
Page options gone, examples slim,
Auth providers now less grim.
In French they pruned with gentle care—
Simpler docs, fresh as springtime air!
🥕📚✨

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.

@studiocms-no-reply
Copy link
Copy Markdown
Member

studiocms-no-reply commented Aug 5, 2025

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/config-reference/features.mdx Localization changed, will be marked as complete.
fr/config-reference/index.mdx Localization changed, will be marked as complete.
fr/config-reference/locale.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 (1)
src/content/docs/fr/config-reference/features.mdx (1)

262-262: Typographical apostrophe should be typographic “’”, not ASCII '.

Replace the straight apostrophe with the French typographic apostrophe to follow the docs’ typography conventions.

-Le fournisseur suivant peut être configuré à partir d'ici : `usernameAndPassword`.
+Le fournisseur suivant peut être configuré à partir d’ici : `usernameAndPassword`.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ce3b2d3 and 40f512b.

📒 Files selected for processing (3)
  • src/content/docs/fr/config-reference/features.mdx (1 hunks)
  • src/content/docs/fr/config-reference/index.mdx (0 hunks)
  • src/content/docs/fr/config-reference/locale.mdx (0 hunks)
💤 Files with no reviewable changes (2)
  • src/content/docs/fr/config-reference/index.mdx
  • src/content/docs/fr/config-reference/locale.mdx
🧰 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-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#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#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.
📚 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/config-reference/features.mdx
🪛 LanguageTool
src/content/docs/fr/config-reference/features.mdx

[typographical] ~262-~262: Caractère d’apostrophe incorrect.
Context: ...nt peut être configuré à partir d'ici : usernameAndPassword. #### Utilisation ```ts twoslash {4-9...

(APOS_INCORRECT)

⏰ 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 (1)
src/content/docs/fr/config-reference/features.mdx (1)

266-278: Verify property names in the providers example.

The example mixes the flag (usernameAndPassword) and its config object (usernameAndPasswordConfig) as sibling keys.
Double-check that this structure still matches the latest TypeScript schema exposed by defineStudioCMSConfig; if the config object is now expected to be nested or renamed (e.g. usernameAndPassword: { allowUserRegistration: true }), the doc will mislead integrators.

@dreyfus92 dreyfus92 merged commit 21b126c into withstudiocms:main Aug 5, 2025
8 checks passed
@ArmandPhilippot ArmandPhilippot deleted the i18n/fr-update-config-reference branch August 5, 2025 21:14
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