Skip to content

docs: some adjustment suggestions for cli.mdx [i18nIgnore]#104

Merged
trueberryless merged 1 commit into
mainfrom
trueberryless-cli
Apr 20, 2025
Merged

docs: some adjustment suggestions for cli.mdx [i18nIgnore]#104
trueberryless merged 1 commit into
mainfrom
trueberryless-cli

Conversation

@trueberryless
Copy link
Copy Markdown
Member

@trueberryless trueberryless commented Apr 20, 2025

Description

Fix a grammatically mistake if I'm not mistaken...
Adjust the order of the list so it matches the heading order and add a . at the end of each item

Summary by CodeRabbit

  • Documentation
    • Improved grammar and punctuation in the CLI documentation.
    • Reordered CLI list items for better clarity.
    • Added a newline at the end of the file.

@trueberryless trueberryless requested a review from a team as a code owner April 20, 2025 15:45
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 20, 2025

Walkthrough

The documentation for the CLI tools was updated to improve grammatical accuracy and adjust the order of the listed CLI entries. Minor formatting corrections were made, including adding a period to one description and inserting a newline at the end of the file. No changes were made to the CLI commands, their options, or usage examples.

Changes

File Change Summary
src/content/docs/en/how-it-works/cli.mdx Corrected grammar in introductory text, reordered CLI list items, added a period, and a final newline.

Suggested reviewers

  • Adammatthiesen

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 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 4550bcc and 9d90c5e.

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

[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...system: - studiocms: The StudioCMS utility CLI. - **[`create...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~23-~23: Loose punctuation mark.
Context: ...create-studiocms](#create-studiocms)**: The StudioCMS project scaffolding CLI. ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~24-~24: Loose punctuation mark.
Context: ...tudiocms/upgrade`](#studiocms-upgrade)**: Upgrade StudioCMS Projects and their Pl...

(UNLIKELY_OPENING_PUNCTUATION)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Run Starlight Link Check
🔇 Additional comments (3)
src/content/docs/en/how-it-works/cli.mdx (3)

20-20: Fix grammatical number agreement.
The sentence now correctly uses the plural verb “are” to match “CLIs,” improving readability and accuracy.


22-24: Reorder list items and standardize punctuation.
The CLI list now mirrors the order of the section headings (moving studiocms before create-studiocms) and each item consistently ends with a period for uniformity.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...system: - studiocms: The StudioCMS utility CLI. - **[`create...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~23-~23: Loose punctuation mark.
Context: ...create-studiocms](#create-studiocms)**: The StudioCMS project scaffolding CLI. ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~24-~24: Loose punctuation mark.
Context: ...tudiocms/upgrade`](#studiocms-upgrade)**: Upgrade StudioCMS Projects and their Pl...

(UNLIKELY_OPENING_PUNCTUATION)


337-337: Verify internal link reference.
A new link reference for [environment-variables] was added—please confirm that the /en/start-here/environment-variables/ path is correct and resolves properly in the deployed documentation.


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
en/how-it-works/cli.mdx Source changed, localizations will be marked as outdated.
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.

@trueberryless trueberryless changed the title docs: some adjustment suggestions for cli.mdx docs: some adjustment suggestions for cli.mdx [i18nIgnore] Apr 20, 2025
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.

thank you @trueberryless 🫡

@trueberryless trueberryless merged commit e785e32 into main Apr 20, 2025
8 checks passed
@trueberryless trueberryless deleted the trueberryless-cli branch April 20, 2025 15:54
ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Apr 21, 2025
dreyfus92 pushed a commit that referenced this pull request Apr 21, 2025
* i18n(fr): update `how-it-works/cli`

See #73 and #104

* fix link in `start-here/getting-started`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants