Repository navigation
docs: add version badges for config options - #3580
Conversation
Deploying rspress-v2 with
|
| Latest commit: |
5c29b71
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://93701b3d.rspress-v2.pages.dev |
| Branch Preview URL: | https://chore-rspack-badge-added-in.rspress-v2.pages.dev |
Rsdoctor Bundle Diff Analysis
Found 5 projects in monorepo, 3 projects with changes. 📊 Quick Summary
📋 Detailed Reports (Click to expand)📁 website_htmlPath:
📦 Download Diff Report: website_html Bundle Diff 📁 website_mdPath:
📦 Download Diff Report: website_md Bundle Diff 📁 website_jsPath:
📦 Download Diff Report: website_js Bundle Diff Generated by Rsdoctor GitHub Action |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a3d5de7b96
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
Pull request overview
Adds a reusable, dependency-free VersionBadge MDX component to the docs site so readers can quickly see which Rspress release introduced specific configuration options, and applies it to six options across EN/ZH config documentation.
Changes:
- Introduce
VersionBadgeReact component and scoped styles for consistent “Added in vX.Y.Z” release badges. - Import and render
VersionBadgenext to selected config options in both English and Chinese docs.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| website/docs/components/VersionBadge.tsx | New badge component that links to the corresponding GitHub release tag. |
| website/docs/components/VersionBadge.module.scss | Styling for the badge (layout, colors, dark mode). |
| website/docs/en/api/config/config-basic.mdx | Adds version badges for siteOrigin and route-related options. |
| website/docs/en/api/config/config-frontmatter.mdx | Adds version badge for icon. |
| website/docs/en/api/config/config-theme.mdx | Adds version badge for injectLlmsHint. |
| website/docs/zh/api/config/config-basic.mdx | Adds version badges for siteOrigin and route-related options. |
| website/docs/zh/api/config/config-frontmatter.mdx | Adds version badge for icon. |
| website/docs/zh/api/config/config-theme.mdx | Adds version badge for injectLlmsHint. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
Add a dependency-free
VersionBadgecomponent based on the Rspack documentation style so readers can identify when configuration options became available. Apply release-linked badges to six recently added options in both English and Chinese documentation.Related Issue
Screenshots
The
route.localeRedirectbadge was verified locally. Please use the website preview generated by CI for visual review.Checklist