Skip to content

docs: add version badges for config options - #3580

Merged
SoonIter merged 2 commits into
mainfrom
chore/rspack-badge-added-in
Aug 3, 2026
Merged

SoonIter merged 2 commits into
mainfrom
chore/rspack-badge-added-in

Conversation

@SoonIter

@SoonIter SoonIter commented Aug 3, 2026

Copy link
Copy Markdown
Member

Summary

Add a dependency-free VersionBadge component 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.localeRedirect badge was verified locally. Please use the website preview generated by CI for visual review.

Checklist

  • Tests updated (not required).
  • Documentation updated.

Copilot AI review requested due to automatic review settings August 3, 2026 08:42
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Aug 3, 2026 •

Copy link
Copy Markdown

Deploying rspress-v2 with  Cloudflare Pages  Cloudflare Pages

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

View logs

@github-actions

github-actions Bot commented Aug 3, 2026 •

Copy link
Copy Markdown
Contributor

Rsdoctor Bundle Diff Analysis

⚠️ Note: The latest commit (876ee018f4) does not have baseline artifacts. Using commit 66f7b51814 for baseline comparison instead. If this seems incorrect, please wait a few minutes and try rerunning the workflow.

Found 5 projects in monorepo, 3 projects with changes.

📊 Quick Summary
Project Total Size Gzip Size Change Gzip Change
website_html 14.2 MB 2.0 MB +2.9 KB (0.0%) +605.0 B (0.0%)
website_md 1.8 MB 262.4 KB +2.0 KB (0.1%) +116.0 B (0.0%)
website_js 16.9 MB 2.9 MB +3.5 KB (0.0%) +1.8 KB (0.1%)
auto_nav_sidebar_html 447.5 KB 93.4 KB 0 0
auto_nav_sidebar_js 543.7 KB 171.3 KB 0 0
📋 Detailed Reports (Click to expand)

📁 website_html

Path: website/doc_build/diff-rsdoctor/website_html/rsdoctor-data.json

📌 Baseline Commit: 66f7b51814 | PR: #3579

Metric Current Baseline Change
📊 Total Size 14.2 MB 14.2 MB +2.9 KB (0.0%)
🗜️ Gzip Size 2.0 MB 2.0 MB +605.0 B (0.0%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 14.2 MB 14.2 MB +2.9 KB (0.0%)
📁 Other Assets 0 B 0 B 0

📦 Download Diff Report: website_html Bundle Diff

📁 website_md

Path: website/doc_build/diff-rsdoctor/website_md/rsdoctor-data.json

📌 Baseline Commit: 66f7b51814 | PR: #3579

Metric Current Baseline Change
📊 Total Size 1.8 MB 1.8 MB +2.0 KB (0.1%)
🗜️ Gzip Size 262.4 KB 262.3 KB +116.0 B (0.0%)
📄 JavaScript 0 B 0 B 0
🎨 CSS 0 B 0 B 0
🌐 HTML 0 B 0 B 0
📁 Other Assets 1.8 MB 1.8 MB +2.0 KB (0.1%)

📦 Download Diff Report: website_md Bundle Diff

📁 website_js

Path: website/doc_build/diff-rsdoctor/website_js/rsdoctor-data.json

📌 Baseline Commit: 66f7b51814 | PR: #3579

Metric Current Baseline Change
📊 Total Size 16.9 MB 16.9 MB +3.5 KB (0.0%)
🗜️ Gzip Size 2.9 MB 2.9 MB +1.8 KB (0.1%)
📄 JavaScript 16.6 MB 16.6 MB +3.1 KB (0.0%)
🎨 CSS 140.5 KB 140.1 KB +440.0 B (0.3%)
🌐 HTML 0 B 0 B 0
📁 Other Assets 172.9 KB 172.9 KB 0

📦 Download Diff Report: website_js Bundle Diff

Generated by Rsdoctor GitHub Action

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread website/docs/en/api/config/config-basic.mdx Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 VersionBadge React component and scoped styles for consistent “Added in vX.Y.Z” release badges.
  • Import and render VersionBadge next 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.

Comment thread website/docs/components/VersionBadge.tsx
@SoonIter
SoonIter enabled auto-merge (squash) August 3, 2026 09:18
@SoonIter
SoonIter requested a review from Timeless0911 August 3, 2026 09:35
@SoonIter
SoonIter merged commit 8ba2678 into main Aug 3, 2026
7 of 8 checks passed
@SoonIter
SoonIter deleted the chore/rspack-badge-added-in branch August 3, 2026 09:35
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