Skip to content

docs: add API reference#65

Merged
chenjiahan merged 1 commit into
mainfrom
chenjiahan/docs-api-reference
Jul 21, 2026
Merged

docs: add API reference#65
chenjiahan merged 1 commit into
mainfrom
chenjiahan/docs-api-reference

Conversation

@chenjiahan

Copy link
Copy Markdown
Member

This PR adds a centralized API reference so users can discover Rstack's main entry point, re-exported tool APIs, and TypeScript type entry points in one place.

It documents the recommended rstack/* import paths with aligned English and Chinese examples and adds the page to both sidebars.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying rstack-cli with  Cloudflare Pages  Cloudflare Pages

Latest commit: 07ce4dc
Status: ✅  Deploy successful!
Preview URL: https://e054f23a.rstack-cli.pages.dev
Branch Preview URL: https://chenjiahan-docs-api-referenc.rstack-cli.pages.dev

View logs

@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: 60d447e7-3069-41a6-aa70-96a420e432df

📥 Commits

Reviewing files that changed from the base of the PR and between f8385c6 and 07ce4dc.

📒 Files selected for processing (4)
  • website/docs/en/guide/_meta.json
  • website/docs/en/guide/api-reference.mdx
  • website/docs/zh/guide/_meta.json
  • website/docs/zh/guide/api-reference.mdx

📝 Walkthrough

Walkthrough

Added localized API reference pages documenting Rstack entry points, tool subpaths, and TypeScript type configuration. Registered the new page in the English and Chinese guide navigation metadata with localized labels.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: adding an API reference documentation page.
Description check ✅ Passed The description accurately describes the new centralized API reference and the added English and Chinese examples.
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-api-reference

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.

@chenjiahan
chenjiahan merged commit 051fd52 into main Jul 21, 2026
4 checks passed
@chenjiahan
chenjiahan deleted the chenjiahan/docs-api-reference branch July 21, 2026 07:58
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