Skip to content

docs(readme): remove QR code example from quick start#275

Merged
BlackHole1 merged 1 commit into
mainfrom
improve-readme-2
Jun 8, 2026
Merged

docs(readme): remove QR code example from quick start#275
BlackHole1 merged 1 commit into
mainfrom
improve-readme-2

Conversation

@BlackHole1

Copy link
Copy Markdown
Member

The QR code line was an inaccurate example of what the bundled oo skill routes to a hosted capability, so drop it from both the English and Chinese README to avoid implying an unsupported workflow.

The QR code line was an inaccurate example of what the bundled oo
skill routes to a hosted capability, so drop it from both the English
and Chinese README to avoid implying an unsupported workflow.

Signed-off-by: Kevin Cui <bh@bugs.cc>
@coderabbitai

coderabbitai Bot commented Jun 8, 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

Run ID: 50c894c2-e491-4d13-8d22-da8871952943

📥 Commits

Reviewing files that changed from the base of the PR and between e897211 and cfb6cbc.

📒 Files selected for processing (2)
  • README-ZH_CN.md
  • README.md
💤 Files with no reviewable changes (2)
  • README-ZH_CN.md
  • README.md

Summary by CodeRabbit

  • Documentation
    • Updated Quick Start examples demonstrating Gmail email summarization using the /oo feature. Both English and Chinese documentation refreshed with the new example.

Walkthrough

This PR updates the quick start example prompts in both the English and Chinese README files. The example instruction shown to users is changed from generating a QR code for https://oomol.com to summarizing the latest 5 Gmail messages. Both changes maintain the existing explanation of the /oo trigger prefix convention used throughout the documentation.

Possibly related PRs

  • oomol-lab/oo-cli#226: Both PRs modify the same README "Quick start" /oo Gmail summarization example.
  • oomol-lab/oo-cli#224: Both PRs modify the README*.md "快速开始" /oo prompt example with the QR code and Gmail summarization variations.
  • oomol-lab/oo-cli#223: Both PRs modify the README.md and README-ZH_CN.md "Quick start" content around the /oo prompt convention with example updates.
🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title follows the required format <type>(<scope>): <subject> with 'docs' as type and 'readme' as scope, accurately reflecting the removal of the QR code example from the README files.
Description check ✅ Passed The description is directly related to the changeset, explaining the rationale for removing the QR code example from both README files to avoid implying an unsupported workflow.
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.

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

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch improve-readme-2

Comment @coderabbitai help to get the list of available commands and usage tips.

@BlackHole1 BlackHole1 merged commit 6cdcf71 into main Jun 8, 2026
6 checks passed
@BlackHole1 BlackHole1 deleted the improve-readme-2 branch June 8, 2026 09:22
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