Skip to content

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

Merged
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-how-it-works
Mar 19, 2026
Merged

i18n(fr): update how-it-works#252
Adammatthiesen merged 1 commit into
withstudiocms:mainfrom
ArmandPhilippot:i18n/fr-update-how-it-works

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Mar 18, 2026

Description

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

Summary by CodeRabbit

  • Documentation
    • Removed migrator tool documentation from French CLI guide
    • Reorganized how-it-works documentation with collapsible content sections for improved readability
    • Simplified API endpoint documentation with external reference links

@ArmandPhilippot ArmandPhilippot requested a review from a team as a code owner March 18, 2026 21:22
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 18, 2026

📝 Walkthrough

Walkthrough

French documentation files restructured to replace detailed route and endpoint lists with ReadMore components linking to comprehensive documentation, and removed @studiocms/migrator documentation section from CLI reference.

Changes

Cohort / File(s) Summary
CLI Documentation
src/content/docs/fr/how-it-works/cli.mdx
Removed entire @studiocms/migrator documentation section including list entry and usage/installation examples.
How-It-Works Index
src/content/docs/fr/how-it-works/index.mdx
Added ReadMore component import and wrapped detailed route lists (authentication, API dashboard, SDK routes) in collapsible ReadMore blocks with links to corresponding documentation.
REST API Documentation
src/content/docs/fr/how-it-works/restapi.mdx
Replaced explicit public and protected API endpoint lists with ReadMore component linking to full API REST documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

i18n

Suggested reviewers

  • dreyfus92
  • Adammatthiesen

Poem

🐰 A rabbit hops through docs so fine,
Collapsing lists with ReadMore's line,
Less clutter shown, more ease to find,
French pages now? Much cleaner designed! 📚✨

🚥 Pre-merge checks | ✅ 3
✅ 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 'i18n(fr): update how-it-works' accurately describes the main change: updating French translations for the how-it-works documentation section.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
📝 Coding Plan
  • Generate coding plan for human review comments

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/how-it-works/cli.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/restapi.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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/content/docs/fr/how-it-works/index.mdx`:
- Around line 80-82: The ReadMore block contains a broken French link to
/fr/api-docs/auth/ — update the href inside the ReadMore component in
src/content/docs/fr/how-it-works/index.mdx to point to the existing English docs
(/en/api-docs/auth/) or, if the project policy is to wait for translations,
replace the link with a translated notice and remove the broken URL; locate the
ReadMore entry referencing "/fr/api-docs/auth/" and either change the path to
"/en/api-docs/auth/" or swap the link for a short message like "Documentation
disponible en anglais: /en/api-docs/auth/" pending French translation.

In `@src/content/docs/fr/how-it-works/restapi.mdx`:
- Around line 25-27: The French page restapi.mdx currently links to a
non-existent path '/fr/api-docs/rest-api/'; either add the missing French
translation file for the REST API docs or change the link to a valid fallback
(for example '/en/api-docs/rest-api/'); update the anchor text if needed and
ensure the href in restapi.mdx points to the chosen existing file so the link is
not broken.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4d5b281a-6cb9-4d4f-be50-28df48ee58da

📥 Commits

Reviewing files that changed from the base of the PR and between cf9dade and b22313d.

📒 Files selected for processing (3)
  • src/content/docs/fr/how-it-works/cli.mdx
  • src/content/docs/fr/how-it-works/index.mdx
  • src/content/docs/fr/how-it-works/restapi.mdx
💤 Files with no reviewable changes (1)
  • src/content/docs/fr/how-it-works/cli.mdx

Comment thread src/content/docs/fr/how-it-works/index.mdx
Comment thread src/content/docs/fr/how-it-works/restapi.mdx
@Adammatthiesen Adammatthiesen merged commit d7175d1 into withstudiocms:main Mar 19, 2026
8 checks passed
@ArmandPhilippot ArmandPhilippot deleted the i18n/fr-update-how-it-works branch March 19, 2026 11:29
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