docs: small code highlight update by trueberryless · Pull Request #106 · withstudiocms/docs

trueberryless · 2025-04-20T18:56:32Z

Description

Highlight grey instead of green because not manually added

Summary by CodeRabbit

Documentation
- Updated code block annotations in StudioCMS plugin documentation for improved code snippet highlighting across multiple plugins.

coderabbitai · 2025-04-20T18:56:39Z

Walkthrough

The changes update multiple StudioCMS plugin documentation files by modifying the fenced code block annotations. Specifically, the ins= prefix is removed from the twoslash code block range specifiers in the examples, changing from ins={2, 6} to {2, 6}. This affects the highlighting or annotation of specific lines in the code snippets without altering the code content, logic, or any exported entities.

Changes

File(s)	Change Summary
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-blog.mdx	Removed the `ins=` prefix from the twoslash code block range specifier in the fenced code block.
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-markdoc.mdx, studiocms-mdx.mdx, studiocms-wysiwyg.mdx	Removed the `ins=` prefix from the twoslash code block range specifier in fenced code blocks; added a newline in one file.

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 16df9a8 and e7828d7.

📒 Files selected for processing (3)

src/content/docs/en/package-catalog/studiocms-plugins/studiocms-markdoc.mdx (2 hunks)
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-mdx.mdx (2 hunks)
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx (2 hunks)

✅ Files skipped from review due to trivial changes (3)

src/content/docs/en/package-catalog/studiocms-plugins/studiocms-mdx.mdx
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx
src/content/docs/en/package-catalog/studiocms-plugins/studiocms-markdoc.mdx

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: Run Starlight Link Check

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 · 2025-04-20T18:57:02Z

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/package-catalog/studiocms-plugins/studiocms-blog.mdx	Source changed, localizations will be marked as outdated.
en/package-catalog/studiocms-plugins/studiocms-markdoc.mdx	Source changed, localizations will be marked as outdated.
en/package-catalog/studiocms-plugins/studiocms-mdx.mdx	Source changed, localizations will be marked as outdated.
en/package-catalog/studiocms-plugins/studiocms-wysiwyg.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.

dreyfus92

The green highlighting means that is something that you should add to your code in order work properly, I don't get why we should make it gray, it isn't intuitive for me. What's the reasoning behind this change? 🫣

trueberryless · 2025-04-20T19:44:18Z

Yes, before beta.16 you had to add the code manually, but since the new CLI this code gets added by the CLI as the text before the code block says... So you don't need to add it, it's already been added as I understood it

Adammatthiesen · 2025-04-20T22:05:48Z

The green highlighting means that is something that you should add to your code in order work properly, I don't get why we should make it gray, it isn't intuitive for me. What's the reasoning behind this change? 🫣

Yeah, I did consider this, but was a bit more focused on just updating the docs with the new syntax... since the final step is more of a verification step now, it makes sense.

See withstudiocms#106

* i18n(fr): update `package-catalog` See #73 * update code blocks highlighting See #106

See withstudiocms#73 and withstudiocms#106

…124) See #73 and #106 Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>

docs: small code highlight update

16df9a8

trueberryless requested a review from a team as a code owner April 20, 2025 18:56

docs: small update here too

dd9a035

coderabbitai Bot approved these changes Apr 20, 2025

View reviewed changes

trueberryless added 2 commits April 20, 2025 20:58

docs: here too :)

932a882

docs: I use Github UI, so one file at a time...

e7828d7

trueberryless mentioned this pull request Apr 20, 2025

i18n(de): update German translation #107

Merged

dreyfus92 reviewed Apr 20, 2025

View reviewed changes

louisescher approved these changes Apr 20, 2025

View reviewed changes

Adammatthiesen approved these changes Apr 20, 2025

View reviewed changes

dreyfus92 approved these changes Apr 20, 2025

View reviewed changes

Adammatthiesen merged commit b313ae1 into main Apr 21, 2025
8 checks passed

Adammatthiesen deleted the trueberryless-blog branch April 21, 2025 00:32

ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Apr 21, 2025

update code blocks highlighting

91ed02a

See withstudiocms#106

ArmandPhilippot mentioned this pull request Apr 21, 2025

i18n(fr): update package-catalog #121

Merged

dreyfus92 pushed a commit that referenced this pull request Apr 21, 2025

i18n(fr): update package-catalog (#121)

2f412d8

* i18n(fr): update `package-catalog` See #73 * update code blocks highlighting See #106

ArmandPhilippot added a commit to ArmandPhilippot/studiocms-docs that referenced this pull request Apr 21, 2025

i18n(fr): add package-catalog/studiocms-plugins/studiocms-wysiwyg

936ca1a

See withstudiocms#73 and withstudiocms#106

ArmandPhilippot mentioned this pull request Apr 21, 2025

i18n(fr): add package-catalog/studiocms-plugins/studiocms-wysiwyg #124

Merged

dreyfus92 added a commit that referenced this pull request Apr 21, 2025

i18n(fr): add package-catalog/studiocms-plugins/studiocms-wysiwyg (#…

3682f88

…124) See #73 and #106 Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>

jsparkdev mentioned this pull request Apr 22, 2025

i18n(ko-KR): update code highlights #125

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: small code highlight update#106

docs: small code highlight update#106
Adammatthiesen merged 4 commits into
mainfrom
trueberryless-blog

trueberryless commented Apr 20, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Apr 20, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

studiocms-no-reply commented Apr 20, 2025 •

edited

Loading

Uh oh!

dreyfus92 left a comment •

edited

Loading

Uh oh!

trueberryless commented Apr 20, 2025

Uh oh!

Adammatthiesen commented Apr 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

trueberryless commented Apr 20, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Apr 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

studiocms-no-reply commented Apr 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Lunaria Status Overview

Tracked Files

Uh oh!

dreyfus92 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

trueberryless commented Apr 20, 2025

Uh oh!

Adammatthiesen commented Apr 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

trueberryless commented Apr 20, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Apr 20, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

studiocms-no-reply commented Apr 20, 2025 •

edited

Loading

dreyfus92 left a comment •

edited

Loading