Repository navigation
Upgrade docs site to Rspress 2.1.0 - #634
Merged
Merged
Conversation
Use the built-in sitemap, llms.txt, and clean URLs instead of the legacy plugin and duplicate flags, and retarget anchors rejected by the new check. Co-authored-by: Ryan Wang <i@ryanc.cc>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
docs | a1bd50b | Commit Preview URL Branch Preview URL |
Nov 02 2026, 11:56 AM |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Upgrades the Halo docs site from Rspress 2.0.23 to 2.1.0 and drops config that now duplicates built-in defaults.
@rspress/coreis^2.1.0(lockfile resolves to 2.1.0).@rspress/plugin-sitemapis removed. Sitemap generation is built into Rspress 2.1.0 and is on by default. The old plugin only setsiteUrltohttps://docs.halo.run, which is alreadysiteOrigin, so nositemap.siteUrloverride was added.llms: trueandroute.cleanUrls: true. Both are default in 2.1.0, sollms.txt/llms-full.txtand extensionless URLs stay enabled. Built-in WebMCP and anchor checks also stay at their 2.1.0 defaults (on). Dead-link and dead-image checks were already explicit and are unchanged.lang: "zh"); there is no English locale tree to migrate.@rspress/core@2.1.0and@rspress/shared@2.1.0inminimumReleaseAgeExclude. 2.1.0 was published inside the default 24-hour release-age window, and a later frozen install needs those exclusions.manifest.mdno longer links to#run-with-devtools/#run-with-traditional-way. Those ids are not registered because the steps live insidePageTabs. Both links go to#运行插件.api-client.mdno longer links to#使用on the plugin API request page. That heading does not exist. The link goes to#选择客户端.Behavior that changes with 2.1.0
https://docs.halo.run/...) and omit.html. The build wrote 255 entries; the homepage priority is1.0..htmlfiles on disk, but in-page links omit the suffix (clean URLs).llms.txtandllms-full.txtare still emitted, with absolutedocs.halo.runlinks and the hidden llms hint in each page.The bundled
js-yamlupdate is inside@rspress/core. This repo does not depend onjs-yamldirectly; the lockfile still has transitivejs-yaml@4.3.1.Verification
pnpm installpnpm build— Rspress v2.1.0, sitemap for 255 pages, HTML and Markdown SSG both succeededpnpm check:ci— Rslint and Rsfmt passedpnpm preview— HTTP 200 for/,/guide/, the hello-world, manifest, and API request pages, plus/sitemap.xml,/llms.txt, and/llms-full.txt. Served HTML containsid="运行插件",id="选择客户端", and clean links such as/developer-guide/plugin/hello-world#运行插件.