Skip to content

docs: add cli docs#355

Merged
hexqi merged 3 commits into
opentiny:developfrom
gene9831:docs/cli-docs
May 30, 2026
Merged

docs: add cli docs#355
hexqi merged 3 commits into
opentiny:developfrom
gene9831:docs/cli-docs

Conversation

@gene9831
Copy link
Copy Markdown
Collaborator

@gene9831 gene9831 commented May 29, 2026

  • 添加CLI介绍文档(移除了之前的CLI旧文档)
  • 快速开始里面,增加了推荐使用 CLI 的 tip
  • 顺便修复了一个 @opentiny/vue-theme 样式覆盖的问题
    实际上就是 Layout 组件的 class 类名匹配到了 @opentiny/vue-theme 的一个选择器,导致很多样式变成 @opentiny/vue-theme 的样式了

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 29, 2026

Walkthrough

This PR reorganizes CLI documentation by creating a comprehensive new CLI integration guide, promotes CLI usage throughout the quick-start guide, updates navigation to expose the new guide, and performs minor CSS class cleanup on the layout component.

Changes

CLI Documentation Reorganization

Layer / File(s) Summary
CLI integration documentation
docs/src/guide/cli-integration.md
Comprehensive new guide for @opentiny/tiny-robot-cli covering installation via npx/pnpm dlx, create command to scaffold new projects, add command to integrate into existing Vue projects with workspace support, post-integration setup steps, and configuration requirements.
Quick-start guide CLI promotion
docs/src/guide/quick-start.md
Quick-start updated with outline configuration change, new tip block recommending CLI for first-time users with links to CLI guides, updated style import example, and new "CLI 快速接入" section with create/add commands and generated file checklist.
Navigation sidebar configuration
docs/.vitepress/themeConfig.ts
Sidebar configuration updated to add "CLI 接入" guide link under "指南" section, replacing the previous tools CLI entry.
Layout CSS class rename
docs/.vitepress/theme/Layout.vue
Root layout container class renamed from tiny-robot-layout to tr-layout in template and corresponding scoped CSS selector.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~8 minutes

Suggested reviewers

  • hexqi

Poem

🐰 A rabbit hops through docs with glee,
CLI guide and quick-start—now you see!
Navigation flows, styles refine,
Every link and class align. ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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.
Title check ✅ Passed The title accurately reflects the main changes: reorganizing CLI documentation by moving content from tools/cli.md to a new guide/cli-integration.md, updating sidebar navigation, and enhancing quick-start.md with CLI integration guidance.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 29, 2026

✅ Preview build completed successfully!

Click the image above to preview.
Preview will be automatically removed when this PR is closed.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 29, 2026

Comment thread docs/src/guide/cli-integration.md Outdated
Comment thread docs/.vitepress/themeConfig.ts
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/src/guide/cli-integration.md`:
- Around line 118-125: The heading "API_KEY" is ambiguous compared to the
example env var; update the text in cli-integration.md to explicitly name and
use a single environment variable (VITE_DEEPSEEK_API_KEY) everywhere: replace
the generic heading "API_KEY" with "VITE_DEEPSEEK_API_KEY" (or add a clarifying
sentence "Use VITE_DEEPSEEK_API_KEY as generated by the CLI"), ensure the
example shows VITE_DEEPSEEK_API_KEY=your_api_key and add one line stating "The
CLI-generated key must be set in VITE_DEEPSEEK_API_KEY" so the variable name is
unique and unambiguous.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 015d8a92-edc6-4050-9dbf-1b170d237cde

📥 Commits

Reviewing files that changed from the base of the PR and between 4f01301 and bebde5a.

📒 Files selected for processing (5)
  • docs/.vitepress/theme/Layout.vue
  • docs/.vitepress/themeConfig.ts
  • docs/src/guide/cli-integration.md
  • docs/src/guide/quick-start.md
  • docs/src/tools/cli.md
💤 Files with no reviewable changes (1)
  • docs/src/tools/cli.md

Comment thread docs/src/guide/cli-integration.md
@hexqi hexqi changed the title feat(docs): add cli docs docs: add cli docs May 30, 2026
@hexqi hexqi merged commit 1ca6c49 into opentiny:develop May 30, 2026
4 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

🧹 Preview Cleaned Up

The preview deployment has been removed.

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.

2 participants