Skip to content

i18n(fr): update how-it-works#155

Merged
dreyfus92 merged 2 commits into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-how-it-works
Aug 6, 2025
Merged

i18n(fr): update how-it-works#155
dreyfus92 merged 2 commits into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-how-it-works

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Aug 6, 2025 •
edited by coderabbitai Bot
Loading

Description

Adds changes from #150 to the French translations in how-it-works.

Summary by CodeRabbit

  • Documentation
    • Updated French documentation for StudioCMS integration to reference new component registry modules and simplified authentication API endpoints.
    • Removed badge indicators from the French CLI and Effect documentation pages.
    • Updated SDK example in the French documentation to simplify the Effect generator code.

@ArmandPhilippot ArmandPhilippot requested a review from a team as a code owner August 6, 2025 10:32
@studiocms-no-reply
Copy link
Copy Markdown
Member

studiocms-no-reply commented Aug 6, 2025 •
edited
Loading

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/how-it-works/cli.mdx Localization changed, will be marked as complete.
fr/how-it-works/effect.mdx Localization changed, will be marked as complete.
fr/how-it-works/index.mdx Localization changed, will be marked as complete.
fr/how-it-works/sdk.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 •
edited
Loading

Walkthrough

This update removes the "badge" metadata from the sidebar frontmatter in several French documentation files, updates the StudioCMS integration and authentication documentation to use new module names and parameterized endpoints, and modifies the SDK example to eliminate explicit environment provision in an Effect generator.

Changes

Cohort / File(s) Change Summary
Badge Metadata Removal (French Docs)
src/content/docs/fr/how-it-works/cli.mdx, src/content/docs/fr/how-it-works/effect.mdx		 Removed the "badge" section from the sidebar metadata in the frontmatter of the French CLI and Effect documentation files.
StudioCMS Integration & Auth API Docs Update
src/content/docs/fr/how-it-works/index.mdx		 Updated StudioCMS integration docs to list new module names and consolidated authentication API endpoints using a [provider] placeholder.
SDK Effect Example Update
src/content/docs/fr/how-it-works/sdk.mdx		 Removed the .pipe(Effect.provide(SDKCore.Default)) call from the pagesEffect generator, returning the Effect directly.

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant Docs
  participant StudioCMS
  participant AuthAPI

  User->>Docs: Reads integration guide
  Docs->>StudioCMS: References new component registry modules
  User->>Docs: Reads authentication API section
  Docs->>AuthAPI: Shows parameterized endpoint pattern ([provider])
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

Suggested reviewers

  • dreyfus92
  • Adammatthiesen

Poem

A badge once hopped in the sidebar's green,
Now the docs are tidy, fresh, and clean.
SDK pipes trimmed, endpoints refined,
StudioCMS modules, neatly aligned.
With every hop, the docs improve,
A rabbit’s touch in every move! 🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

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

📜 Recent 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 ef6ef1b.

📒 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 (0 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 (2)
  • src/content/docs/fr/how-it-works/effect.mdx
  • src/content/docs/fr/how-it-works/cli.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-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/how-it-works/index.mdx
🪛 LanguageTool
src/content/docs/fr/how-it-works/index.mdx

[typographical] ~113-~113: Caractère d’apostrophe incorrect.
Context: ... est le nom du fournisseur (par exemple github, discord, google, auth0). - **`/s...

(APOS_INCORRECT)

[typographical] ~113-~113: Caractère d’apostrophe incorrect.
Context: ...m du fournisseur (par exemple github, discord, google, auth0). - **`/studiocms_ap...

(APOS_INCORRECT)

[typographical] ~113-~113: Caractère d’apostrophe incorrect.
Context: ...sseur (par exemple github, discord, google, auth0). - **`/studiocms_api/auth/[pr...

(APOS_INCORRECT)

[typographical] ~113-~113: Caractère d’apostrophe incorrect.
Context: ... exemple github, discord, google, auth0). - **`/studiocms_api/auth/[provider]/c...

(APOS_INCORRECT)

[typographical] ~114-~114: Caractère d’apostrophe incorrect.
Context: ... est le nom du fournisseur (par exemple github, discord, google, auth0). #### R...

(APOS_INCORRECT)

[typographical] ~114-~114: Caractère d’apostrophe incorrect.
Context: ...m du fournisseur (par exemple github, discord, google, auth0). #### Routes du SD...

(APOS_INCORRECT)

[typographical] ~114-~114: Caractère d’apostrophe incorrect.
Context: ...sseur (par exemple github, discord, google, auth0). #### Routes du SDK - **`/s...

(APOS_INCORRECT)

[typographical] ~114-~114: Caractère d’apostrophe incorrect.
Context: ... exemple github, discord, google, auth0). #### Routes du SDK - **`/studiocms_...

(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 (3)
src/content/docs/fr/how-it-works/sdk.mdx (1)

27-34: No manual Effect.provide needed—runSDK injects the default SDKCore environment
The examples across our docs (e.g. in utils/rendering.mdx) all call runSDK(...) without an explicit Effect.provide, which confirms that runSDK wraps your effect with SDKCore.Default under the hood. You can safely copy-paste the snippet as-is.

• src/content/docs/en/how-it-works/sdk.mdx line 36
• src/content/docs/fr/how-it-works/sdk.mdx line 36

src/content/docs/fr/how-it-works/index.mdx (2)

42-44: New “component-registry” modules look good

The addition aligns with the upstream rename from component-proxy; wording and accentuation are correct.
Nothing else to flag.

113-114: Parameterized auth routes: verify parity with EN version

Good simplification, but double-check that the English source also uses [provider] so translations stay in sync.

✨ 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 6, 2025 •
edited
Loading

✅ Deploy Preview for studiocms-dev-docs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit bbefdb0
🔍 Latest deploy log https://app.netlify.com/projects/studiocms-dev-docs/deploys/6893a8aa1697030008b9f12c
😎 Deploy Preview https://deploy-preview-155--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.

dreyfus92
dreyfus92 approved these changes Aug 6, 2025
View reviewed changes
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.

LGTM 🤘🏻

@dreyfus92 dreyfus92 merged commit 75aca07 into withstudiocms:main Aug 6, 2025
12 checks passed
@ArmandPhilippot ArmandPhilippot deleted the i18n/fr-update-how-it-works branch August 6, 2025 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dreyfus92 dreyfus92 dreyfus92 approved these changes

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees

No one assigned

Labels

i18n

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ArmandPhilippot @studiocms-no-reply @dreyfus92