Skip to content

docs: add Browser CLI usage guides and install-skills docs#15

Merged
xhwSkhizein merged 2 commits intomainfrom
docs/browser-cli-guides-and-install-skills
Apr 15, 2026
Merged

docs: add Browser CLI usage guides and install-skills docs#15
xhwSkhizein merged 2 commits intomainfrom
docs/browser-cli-guides-and-install-skills

Conversation

@xhwSkhizein
Copy link
Copy Markdown
Owner

@xhwSkhizein xhwSkhizein commented Apr 15, 2026

Summary

  • add a Chinese project guide that explains Browser CLI architecture and mental model
  • add a Chinese usage guide focused on installation, daily commands, tasks, and automation
  • document browser-cli install-skills in the README and installed-user docs, plus add a dedicated install guide

Testing

  • not run (docs-only changes)

Summary by CodeRabbit

  • Documentation
    • Added comprehensive documentation for the browser-cli install-skills command, including installation of three packaged skills (browser-cli-converge, browser-cli-delivery, browser-cli-explore) with --dry-run and --target options.
    • Added new Chinese language documentation for project architecture overview and usage guide.
    • Updated installation guide with skills installation workflow.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 15, 2026

Warning

Rate limit exceeded

@xhwSkhizein has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 37 minutes and 56 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 37 minutes and 56 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: dc598cf5-4695-4821-abca-38852bb445e2

📥 Commits

Reviewing files that changed from the base of the PR and between 59bf75a and 9e6350c.

📒 Files selected for processing (2)
  • docs/browser-cli-project-guide-zh.md
  • docs/browser-cli-usage-guide-zh.md
📝 Walkthrough

Walkthrough

Adds comprehensive documentation for a new browser-cli install-skills command that installs three packaged skills to a configurable destination, introduces Chinese-language architectural and usage guides, and updates existing getting-started documentation to incorporate the new installation workflow.

Changes

Cohort / File(s) Summary
Install-Skills Documentation
docs/install-skills.md, README.md, docs/installed-with-uv.md
Introduces documentation for the install-skills command, detailing the three packaged skills (browser-cli-converge, browser-cli-delivery, browser-cli-explore), default installation destination (~/.agents/skills), and options like --dry-run and --target. Updates first-day path to include the installation step.
Chinese Language Guides
docs/browser-cli-project-guide-zh.md, docs/browser-cli-usage-guide-zh.md
Adds two new Chinese-language guides: a top-down architectural overview covering the three-tier system (read operations, daemon-driven interactions, and task/automation abstractions), and a practical usage guide detailing command workflows from initial verification through task execution and automation publishing.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~8 minutes

Poem

🐰 Five docs now bloom where none did grow,
A Chinese tongue joins the English flow,
install-skills lights the path so bright,
From first-day steps to agent heights! 🌟

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description covers main changes and testing approach, but lacks required template sections like Type of Change, Checklist, and Architectural Boundaries. Fill in the PR template sections: mark documentation as the type of change, check relevant items in the Checklist, and confirm architectural alignment if applicable.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: adding Browser CLI usage guides and install-skills documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/browser-cli-guides-and-install-skills

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.

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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/browser-cli-project-guide-zh.md`:
- Line 13: Replace the hard-coded absolute path
"/home/hongv/workspace/browser-cli/src/browser_cli/cli/main.py" with a
repository-relative path (e.g., "src/browser_cli/cli/main.py" or
"./src/browser_cli/cli/main.py") in docs/browser-cli-project-guide-zh.md; search
for other absolute paths mentioned in the same file (lines noted in the review)
and convert them all to repository-relative paths to ensure links work for other
readers and environments.

In `@docs/browser-cli-usage-guide-zh.md`:
- Around line 228-230: The three markdown links in
docs/browser-cli-usage-guide-zh.md use local absolute paths; update them to
repository-relative paths so they work for all readers: change
/home/hongv/workspace/browser-cli/tasks/interactive_reveal_capture/task.py,
/home/hongv/workspace/browser-cli/tasks/lazy_scroll_capture/task.py, and
/home/hongv/workspace/browser-cli/tasks/douyin_video_download/task.py to
relative links like tasks/interactive_reveal_capture/task.py,
tasks/lazy_scroll_capture/task.py, and tasks/douyin_video_download/task.py
(preserve the existing markdown link syntax and filenames).
🪄 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: defaults

Review profile: CHILL

Plan: Pro

Run ID: 16573ce7-e617-47c0-99ed-672040ee15a0

📥 Commits

Reviewing files that changed from the base of the PR and between 267a4ba and 59bf75a.

📒 Files selected for processing (5)
  • README.md
  • docs/browser-cli-project-guide-zh.md
  • docs/browser-cli-usage-guide-zh.md
  • docs/install-skills.md
  • docs/installed-with-uv.md

Comment thread docs/browser-cli-project-guide-zh.md Outdated
Comment thread docs/browser-cli-usage-guide-zh.md Outdated
@xhwSkhizein xhwSkhizein merged commit 547e4f4 into main Apr 15, 2026
8 checks passed
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