Skip to content

docs: polish website documentation#68

Merged
chenjiahan merged 3 commits into
mainfrom
chenjiahan/docs-polish-website
Jul 21, 2026
Merged

docs: polish website documentation#68
chenjiahan merged 3 commits into
mainfrom
chenjiahan/docs-polish-website

Conversation

@chenjiahan

Copy link
Copy Markdown
Member

Summary

The website documentation has accumulated inconsistent phrasing and a few imprecise technical descriptions across the English and Chinese pages.

This PR polishes the guide and CLI reference, aligns bilingual structure and terminology, and clarifies Rstack configuration, testing, and staged-file behavior. It changes documentation only; runtime behavior is unaffected.

@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: 5b6b6b60-9879-4044-b3eb-8ccab527f13f

📥 Commits

Reviewing files that changed from the base of the PR and between 74f3869 and a7ac36d.

📒 Files selected for processing (8)
  • website/README.md
  • website/docs/en/guide/api-reference.mdx
  • website/docs/en/guide/cli/staged.mdx
  • website/docs/en/guide/cli/test.mdx
  • website/docs/zh/guide/api-reference.mdx
  • website/docs/zh/guide/cli/dev.mdx
  • website/docs/zh/guide/cli/staged.mdx
  • website/docs/zh/guide/cli/test.mdx

📝 Walkthrough

Walkthrough

Updated English and Chinese website documentation. API reference entries now clarify when to use rstack/test/globals and the type support provided by rstack/test/importMeta. CLI documentation now clarifies --no-stash, rs test init, and the Chinese development-server link. The README contributing guidance was shortened by removing the TODO placeholder-page note.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately reflects the documentation-only polishing changes across the website docs.
Description check ✅ Passed The description matches the PR by describing documentation-only wording and terminology polish in English and Chinese.
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-polish-website

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.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jul 21, 2026

Copy link
Copy Markdown

Deploying rstack-cli with  Cloudflare Pages  Cloudflare Pages

Latest commit: a7ac36d
Status: ✅  Deploy successful!
Preview URL: https://75592d1d.rstack-cli.pages.dev
Branch Preview URL: https://chenjiahan-docs-polish-websi.rstack-cli.pages.dev

View logs

@chenjiahan
chenjiahan merged commit 33de1af into main Jul 21, 2026
4 checks passed
@chenjiahan
chenjiahan deleted the chenjiahan/docs-polish-website branch July 21, 2026 13:55
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