Skip to content

i18n(fr): update docs for beta.27#166

Merged
dreyfus92 merged 1 commit into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-beta27-docs
Sep 30, 2025
Merged

i18n(fr): update docs for beta.27#166
dreyfus92 merged 1 commit into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-beta27-docs

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Sep 29, 2025

Description

Adds changes from #165 to the French translation of the docs:

  • translate the beta.27 upgrade guide
  • remove the badge from beta.26
  • update a code snippet in how-it-works/effect

Summary by CodeRabbit

  • Documentation
    • Updated the French upgrade guide for 0.1.0-beta.26 by removing the “NOUVEAU” badge from the sidebar label.
    • Added a new French upgrade guide for 0.1.0-beta.27, including front matter, quick update highlights, and sections for new features and bug fixes.
    • Refreshed the “How it works: Effects” French documentation to align with current APIs, removing references to an outdated import and keeping examples consistent.

@ArmandPhilippot ArmandPhilippot requested a review from a team as a code owner September 29, 2025 10:54
@netlify
Copy link
Copy Markdown

netlify Bot commented Sep 29, 2025

Deploy Preview for studiocms-dev-docs ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 666846d
🔍 Latest deploy log https://app.netlify.com/projects/studiocms-dev-docs/deploys/68da65727b09bd0008d3d2ef
😎 Deploy Preview https://deploy-preview-166--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.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Sep 29, 2025

📝 Walkthrough

Walkthrough

Removes a frontmatter badge from the French 0.1.0-beta.26 upgrade guide, adds a new French 0.1.0-beta.27 upgrade guide with frontmatter and content using internal components, and updates a French “how it works” doc to remove an unused import from an example.

Changes

Cohort / File(s) Summary
French upgrade guide badge removal
src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-26.mdx
Removed sidebar.badge block (text “NOUVEAU”, variant: success) from frontmatter.
New beta-27 French guide
src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-27.mdx
Added new MDX page with frontmatter (i18nReady, title, description, sidebar label/badge/order). Imports ReadMore, QuickUpdate, and Aside; includes sections for new features and bug fixes.
Effect import cleanup
src/content/docs/fr/how-it-works/effect.mdx
Updated import list to remove errorTap; keeps runEffect, genLogger, pipeLogger, runtimeLogger.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

i18n

Suggested reviewers

  • dreyfus92
  • louisescher

Poem

A nibble of notes in carrot-bright prose,
I hop through versions where the changelog grows.
Badge is plucked, a fresh guide blooms,
Effects declutter dusty rooms.
Thump-thump! My paws approve this edit spree—
new paths to read, bug-fixes free. 🥕🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title follows a clear type(scope): description convention and accurately conveys that the pull request updates the French documentation for the beta.27 release, which aligns with the primary change in the PR. It is concise, specific to the main objective, and avoids unnecessary detail.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

@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/guides/upgrade/version-guides/0-1-0-beta-26.mdx Localization changed, will be marked as complete.
fr/guides/upgrade/version-guides/0-1-0-beta-27.mdx Localization added, will be marked as complete.
fr/how-it-works/effect.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 (2)
src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-27.mdx (2)

4-4: Include the full version string in the description.

Minor consistency fix with title/label and EN versioning.

-description: Mettre à niveau StudioCMS vers la version Beta.27
+description: Mettre à niveau StudioCMS vers la version 0.1.0-beta.27

21-24: Wording/terminology nit (optional).

If you want slightly tighter phrasing: “Refactorise la CLI pour utiliser le module Clack d’Effect depuis @withstudiocms/effect.” Current text is fine if mirroring EN.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8da4c77 and 666846d.

📒 Files selected for processing (3)
  • src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-26.mdx (0 hunks)
  • src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-27.mdx (1 hunks)
  • src/content/docs/fr/how-it-works/effect.mdx (1 hunks)
💤 Files with no reviewable changes (1)
  • src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-26.mdx
🧰 Additional context used
🧠 Learnings (1)
📓 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.
⏰ 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: Run Starlight Link Check
  • GitHub Check: Redirect rules - studiocms-dev-docs
  • GitHub Check: Header rules - studiocms-dev-docs
  • GitHub Check: Pages changed - studiocms-dev-docs
🔇 Additional comments (4)
src/content/docs/fr/how-it-works/effect.mdx (1)

28-29: Import list matches intended cleanup (sans errorTap)—please confirm parity with EN and exports.

Looks good. Quick check: ensure the EN page shows the same four imports and that studiocms/effect actually exposes all four today. If both are true, we’re aligned; no further action.

Based on learnings

src/content/docs/fr/guides/upgrade/version-guides/0-1-0-beta-27.mdx (3)

13-16: Aside is imported but unused—keep only if needed for parity with EN.

Given our translation policy, retain it if the EN page imports it too; otherwise remove.

Based on learnings


17-17: Confirm QuickUpdate usage matches EN layout.

If EN renders in the same position, we’re good; if not, align placement for structural parity.

Based on learnings


27-30: Great clarity on bug fixes.

The explanations are precise and idiomatic (guillemets, espaces insécables OK). No changes requested.

@dreyfus92 dreyfus92 merged commit 652c7e9 into withstudiocms:main Sep 30, 2025
12 checks passed
@ArmandPhilippot ArmandPhilippot deleted the i18n/fr-update-beta27-docs branch September 30, 2025 19:15
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