Skip to content

docs: complete doc command guide#57

Merged
chenjiahan merged 1 commit into
mainfrom
chenjiahan/docs-doc-command
Jul 21, 2026
Merged

docs: complete doc command guide#57
chenjiahan merged 1 commit into
mainfrom
chenjiahan/docs-doc-command

Conversation

@chenjiahan

Copy link
Copy Markdown
Member

This PR completes the bilingual rs doc command guide so users can understand the Rspress-backed documentation workflow.

It documents setup, usage examples, supported subcommands, and configuration, with links to the relevant Rspress references. The English and Chinese pages remain aligned, including matching heading anchors and PackageManagerTabs installation commands.

@chenjiahan
chenjiahan merged commit caca20a into main Jul 21, 2026
3 checks passed
@chenjiahan
chenjiahan deleted the chenjiahan/docs-doc-command branch July 21, 2026 02:30
@coderabbitai

coderabbitai Bot commented Jul 21, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: b4fd071a-f46d-4ee3-8586-e6cfef8e8a36

📥 Commits

Reviewing files that changed from the base of the PR and between 162206e and 05a4739.

📒 Files selected for processing (2)
  • website/docs/en/guide/cli/doc.mdx
  • website/docs/zh/guide/cli/doc.mdx

📝 Walkthrough

Walkthrough

Expanded the English and Chinese rs doc CLI documentation pages. The pages now cover installation of @rspress/core, command usage, options, examples, the build, preview, and eject subcommands, and configuration through define.doc() in rstack.config.ts.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: completing the rs doc command guide.
Description check ✅ Passed The description matches the documented bilingual rs doc guide updates, including setup, usage, subcommands, and configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chenjiahan/docs-doc-command

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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