Skip to content

docs: add documentation example#4

Merged
chenjiahan merged 2 commits into
mainfrom
chenjiahan/docs-documentation-example
Jul 9, 2026
Merged

docs: add documentation example#4
chenjiahan merged 2 commits into
mainfrom
chenjiahan/docs-documentation-example

Conversation

@chenjiahan

Copy link
Copy Markdown
Member

Summary

This PR adds a documentation example for building an Rspress site with Rstack. It includes starter docs content, Rstack doc/lint configuration, package scripts, TypeScript settings, and the workspace lockfile update.

@coderabbitai

coderabbitai Bot commented Jul 9, 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: 46c40375-9b37-497a-bb28-243ce0fb0472

📥 Commits

Reviewing files that changed from the base of the PR and between e8f235c and 52fb64f.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (1)
  • examples/documentation/rstack.config.ts

📝 Walkthrough

Walkthrough

This pull request adds a new example package at examples/documentation, providing a documentation site built with Rspress. It includes a README, package.json with build/dev/lint/preview scripts, tsconfig.json, and rstack.config.ts configuring the docs root, site title, and lint presets. Content files include a navigation config, API metadata and MDX pages (index and commands), and a home page markdown file with hero content and links.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and clearly summarizes the main change: adding a documentation example.
Description check ✅ Passed The description matches the changeset and summarizes the new documentation example and supporting config files.
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 docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chenjiahan/docs-documentation-example

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.

@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: e8f235ce48

ℹ️ 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 Outdated
Comment thread examples/documentation/rstack.config.ts Outdated
@chenjiahan
chenjiahan merged commit 36cd392 into main Jul 9, 2026
4 checks passed

@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: 52fb64ff18

ℹ️ 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 examples/documentation/README.md
@chenjiahan
chenjiahan deleted the chenjiahan/docs-documentation-example branch July 10, 2026 02:38
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