Skip to content

Migrate documentation site to Rspress - #621

Merged
ruibaby merged 1 commit into
halo-dev:devfrom
ruibaby:upgrade/migrate-to-rspress
Aug 27, 2026
Merged

Migrate documentation site to Rspress#621
ruibaby merged 1 commit into
halo-dev:devfrom
ruibaby:upgrade/migrate-to-rspress

Conversation

@ruibaby

@ruibaby ruibaby commented Aug 27, 2026

Copy link
Copy Markdown
Member

What changed

  • Replace the Docusaurus documentation site with Rspress.
  • Reorganize user and developer documentation with Rspress navigation metadata.
  • Add a task-oriented documentation homepage, shared theme overrides, and responsive styles.
  • Preserve legacy documentation URLs with EdgeOne redirects and link archived versions from the new navigation.
  • Update CI, Node.js, pnpm, Biome, and Rspress-related dependencies.
  • Add repository agent guidance and bundled Rspress skills.

Validation

  • pnpm check:ci
  • pnpm build

@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: 4bd2850885

ℹ️ 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 pnpm-lock.yaml
engines: {node: '>=6.9.0'}
peerDependencies:
'@babel/core': ^7.0.0
---

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Regenerate the lockfile as one YAML document

The second --- starts another complete lockfile document, so dependency installation cannot parse this file; running pnpm install --frozen-lockfile reports ERR_PNPM_BROKEN_LOCKFILE: expected a single document in the stream, but found more. This blocks both fresh local setup and the workflow's Install dependencies step, so regenerate the lockfile rather than concatenating the package-manager bootstrap data with the project lockfile.

AGENTS.md reference: AGENTS.md:L18-L18

Useful? React with 👍 / 👎.

Comment thread README.md

```
$ pnpm start
pnpm start

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Replace the nonexistent start command

After this migration, package.json defines dev but no start script, so following the Local Development instructions fails with ERR_PNPM_NO_SCRIPT. Change this example to pnpm dev (or restore a compatible start alias) so contributors can launch the Rspress server as documented.

AGENTS.md reference: AGENTS.md:L11-L13

Useful? React with 👍 / 👎.

@ruibaby
ruibaby changed the base branch from main to dev August 27, 2026 08:24
@ruibaby
ruibaby merged commit 611926c into halo-dev:dev Aug 27, 2026
1 check passed
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.

1 participant