update docs for beta17#127
Conversation
WalkthroughThis update modifies the documentation by removing the "badge" property from the sidebar metadata in several English documentation files, specifically in the translations guide, CLI documentation, and the upgrade guide for version 0.1.0-beta.16. Additionally, it introduces a new upgrade guide for version 0.1.0-beta.17, which includes a "NEW" badge in its sidebar metadata and details the latest changes, optimizations, bug fixes, and important notes for that release. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
User->>Docs: Access upgrade guide for 0.1.0-beta-17
Docs-->>User: Display guide with "NEW" badge and release details
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (1)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-17.mdx (3)
4-4: Refine description wording.
To maintain consistency with other upgrade guides, consider updating the description to explicitly reference the full version string, e.g.:-description: Upgrade StudioCMS to Beta.17 +description: Upgrade StudioCMS to 0.1.0-beta.17
13-13: Remove unused import.
ReadMoreis imported but not used in this document. Consider removing the import to eliminate dead code:- import ReadMore from '~/components/ReadMore.astro'
19-19: Clarify "No major changes" phrasing.
The intro states there are no major changes but immediately lists a new feedback system under "New Features". Consider rephrasing to:"This release does not include breaking changes, but introduces optimizations, bug fixes, and a new feedback system."
to avoid confusion.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
src/content/docs/en/guides/contributing/translations.mdx(0 hunks)src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-16.mdx(0 hunks)src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-17.mdx(1 hunks)src/content/docs/en/how-it-works/cli.mdx(0 hunks)
💤 Files with no reviewable changes (3)
- src/content/docs/en/how-it-works/cli.mdx
- src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-16.mdx
- src/content/docs/en/guides/contributing/translations.mdx
🔇 Additional comments (4)
src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-17.mdx (4)
1-11: Frontmatter metadata looks good.
The YAML frontmatter correctly setsi18nReady, title, description, sidebar label, badge, and order for the new version guide.
17-17: QuickUpdate component usage is appropriate.
<QuickUpdate />effectively highlights the summary atop the page and aligns with existing patterns.
32-34: Aside note formatting is correct.
The<Aside>block properly highlights the breaking change reminder, matching other upgrade guides and aiding user clarity.
10-10:Details
✅ Verification successful
Verify
ordersequencing.
Ensure thatorder: 999998follows the previous version guide'sorder(e.g.,999997for beta.16) so the sidebar ordering remains correct. You can run:to confirm the previous file's
ordervalue.
🏁 Script executed:
rg -A2 'version-guides/0-1-0-beta-16.mdx'Length of output: 41
🏁 Script executed:
#!/bin/bash # Locate the beta-16 version guide file and show its `order` value with context FILE=$(fd '0-1-0-beta-16.mdx') if [[ -z "$FILE" ]]; then echo "File 0-1-0-beta-16.mdx not found" exit 1 fi rg -n 'order:' -A2 "$FILE"Length of output: 1464
🏁 Script executed:
#!/bin/bash # Check the `order` value in the English beta-16 version guide FILE="src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-16.mdx" if [[ ! -f "$FILE" ]]; then echo "File not found: $FILE" exit 1 fi rg -n 'order:' -A2 "$FILE"Length of output: 269
No changes required:
ordersequencing is correct
- src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-16.mdx →
order: 999999- src/content/docs/en/guides/upgrade/version-guides/0-1-0-beta-17.mdx →
order: 999998The new guide’s
ordervalue correctly follows the previous one in descending sequence, so the sidebar ordering remains intact.
5 participants
TODO before merge:
package.jsonreferences for StudioCMS packagesSummary by CodeRabbit
Summary by CodeRabbit
New Features
Style
Chores