Skip to content

i18n(fr): update how-it-works/cli#122

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

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

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Apr 21, 2025

Description

Summary by CodeRabbit

  • Documentation
    • Expanded and restructured the French documentation for StudioCMS CLI tools, including detailed sections for commands, options, usage examples, and a new section for the @studiocms-upgrade CLI.
    • Improved navigation with a sidebar badge, table of contents, and unified documentation for certain commands.
    • Updated a link in the French "Getting Started" guide to point to the correct French upgrade guide.

@ArmandPhilippot ArmandPhilippot requested a review from a team as a code owner April 21, 2025 15:21
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 21, 2025

Walkthrough

The updates focus on the French documentation for StudioCMS, particularly the CLI tools. The CLI documentation is extensively expanded and reorganized, introducing a new CLI tool, clarifying command usage, and providing comprehensive examples and navigation enhancements. Additionally, a link in the French "getting started" guide is updated to reference the French upgrade guide instead of the English one. No changes are made to code or exported entities.

Changes

File(s) Change Summary
src/content/docs/fr/how-it-works/cli.mdx Major expansion and restructuring of French CLI documentation: adds new CLI tool section, detailed command descriptions, usage examples, improved navigation, and metadata.
src/content/docs/fr/start-here/getting-started.mdx Updates a LinkCard to point to the French upgrade guide instead of the English version.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docs
    User->>Docs: Accesses CLI documentation (French)
    Docs-->>User: Presents expanded, organized CLI tool info with usage examples
    User->>Docs: Accesses "Getting Started" guide
    Docs-->>User: Provides link to French upgrade guide
Loading

Possibly related PRs

Suggested labels

i18n

Suggested reviewers

  • dreyfus92
  • Adammatthiesen

Poem

A bunny hopped through docs so wide,
Tidying CLI guides with Frenchy pride.
New commands and options, clear as day,
Usage examples lead the way.
With links now pointing where they should,
This rabbit knows: clarity is good!
🐇📚✨


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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • 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 generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 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

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/start-here/getting-started.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/how-it-works/cli.mdx (2)

314-314: Nitpick: Capitalize heading "Étiquette"
In French headings, capitalize the first letter. Change to:

#### Étiquette (facultatif)

315-315: Refine phrasing for tag option
Consider tightening the sentence for clarity, e.g.:

Spécifier une étiquette (tag) pour la résolution des paquets ; si aucune n’est fournie, @studiocms-upgrade utilise la plus récente.

🧰 Tools
🪛 LanguageTool

[typographical] ~315-~315: Caractère d’apostrophe incorrect.
Context: ...Il est possible de passer une étiquette (tag) spécifique pour résoudre les paque...

(APOS_INCORRECT)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2f412d8 and dd99173.

📒 Files selected for processing (2)
  • src/content/docs/fr/how-it-works/cli.mdx (4 hunks)
  • src/content/docs/fr/start-here/getting-started.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/fr/how-it-works/cli.mdx

[uncategorized] ~15-15: Le point-virgule est précédé d’une espace fine insécable.
Context: ...em } from '@astrojs/starlight/components'; import ReadMore from '
/components/Read...

(FRENCH_WHITESPACE)


[uncategorized] ~16-16: Le point-virgule est précédé d’une espace fine insécable.
Context: ...adMore from '
/components/ReadMore.astro'; Les interfaces en ligne de commandes (...

(FRENCH_WHITESPACE)


[uncategorized] ~121-~121: Une de ces ponctuations est superflue.
Context: ...a [documentation][turso-docs] de Turso :::note Windows nécessite l’utilisation de...

(grammalecte_typo_ponctuation_superflue3)


[typographical] ~122-~122: Une espace est requise.
Context: ...[documentation][turso-docs] de Turso :::note Windows nécessite l’utilisation de ...

(DEUX_POINTS_ESPACE)


[uncategorized] ~123-~123: Les deux-points sont précédés d’une espace insécable.
Context: ...essite l’utilisation de WSL selon Turso ::: ```log Utilisation : getTurso [option...

(FRENCH_WHITESPACE)


[typographical] ~151-~151: Il manque une espace après le point.
Context: ...nfigurez votre fichier d’environnement (.env) avec des options pour : - Utiliser ...

(ESPACE_APRES_POINT)


[uncategorized] ~152-~152: Ce mot doit commencer par une minuscule.
Context: ...ent (.env) avec des options pour : - Utiliser un exemple de modèle .env - Utilis...

(DEUX_POINTS_MAJ)


[typographical] ~153-~153: Il manque une espace après le point.
Context: ... - Utiliser le générateur interactif .env qui peut : - Configurer une nouve...

(ESPACE_APRES_POINT)


[uncategorized] ~154-~154: Ce mot doit commencer par une minuscule.
Context: ...eur interactif .env qui peut : - Configurer une nouvelle base de données Turso (si ...

(DEUX_POINTS_MAJ)


[style] ~159-~159: Cette structure peut être allégée afin de devenir plus percutante.
Context: ...ique de Turso CLI et l’authentification si nécessaire lors de la configuration d’une base de donné...

(SI_POSSIBLE1)


[uncategorized] ~161-~161: S’il s’agit d’un impératif, mettez un trait d’union.
Context: ...complète des variables d’environnement, consultez la [documentation des variables d’environn...

(grammalecte_gv1__imp_union_le_la_leur__b1_a1_1)


[style] ~289-~289: Une autre structure plus directe dynamisera votre phrase.
Context: ...ntégrations officielles du projet Astro en même temps que vous mettez à niveau StudioCMS. ##...

(EN_MEME_TEMPS1)


[typographical] ~315-~315: Caractère d’apostrophe incorrect.
Context: ...Il est possible de passer une étiquette (tag) spécifique pour résoudre les paque...

(APOS_INCORRECT)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Run Starlight Link Check
🔇 Additional comments (11)
src/content/docs/fr/start-here/getting-started.mdx (1)

15-15: Update French upgrade guide link
The LinkCard now correctly points to /fr/guides/upgrade/latest/ instead of the English version—this aligns the “Mise à niveau” card with the French documentation.

src/content/docs/fr/how-it-works/cli.mdx (10)

7-9: Add "Mis à jour" badge in frontmatter
The new badge signals that this page has been recently updated in the sidebar—good for discoverability.


10-12: Configure table of contents
Adding tableOfContents with minHeadingLevel: 2 and maxHeadingLevel: 4 will generate an in-page index for headings H2–H4, improving navigation in this long document.


20-24: Include new CLI tool "@studiocms/upgrade"
The list of CLI utilities is correctly expanded to include @studiocms/upgrade. The anchor #studiocms-upgrade matches the section heading below.


28-30: Standardize French section headings
The translated heading ### Options et commandes complètes de la CLI under the studiocms section is clear and consistent with French documentation style.


176-176: Align create‑studiocms section heading
Using the same ### Options et commandes complètes de la CLI heading in the create‑studiocms section maintains consistency across CLI docs.


239-239: Clarify command overview
The new heading ### Présentation des commandes succinctly introduces the list of commands in the create‑studiocms section.


269-269: Improve Turso installation instruction
The sentence clearly directs users to Turso’s official documentation for installation—concise and accurate.


285-285: Introduce new @studiocms-upgrade tool
This new section properly names and describes the upgrade CLI utility, matching the entry in the list of tools above.


291-291: Consistent example usage heading
### Exemple d'utilisation mirrors other sections, making the pattern predictable for readers.


311-311: Options heading
The ### Options heading correctly scopes the list of flags for @studiocms-upgrade.

@dreyfus92 dreyfus92 merged commit e883552 into withstudiocms:main Apr 21, 2025
8 checks passed
@ArmandPhilippot ArmandPhilippot deleted the i18n/fr-update-how-it-works/cli branch April 21, 2025 22:54
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