Skip to content

docs(readme): streamline and condense the overview#2

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

docs(readme): streamline and condense the overview#2
BlackHole1 merged 1 commit into
mainfrom
improve-readme

Conversation

@BlackHole1

Copy link
Copy Markdown
Member

The README had grown long with full reference sections for every method (proxy, catalog, apps, raw results, development), which buried the core getting-started flow. Condense it to the essentials — quick start, install, optional precise types, configuration, and error handling — and fold the remaining methods into a compact "More" list that points to examples/ for runnable usage. Add npm and license badges to surface package status at a glance.

The README had grown long with full reference sections for every
method (proxy, catalog, apps, raw results, development), which buried
the core getting-started flow. Condense it to the essentials — quick
start, install, optional precise types, configuration, and error
handling — and fold the remaining methods into a compact "More" list
that points to examples/ for runnable usage. Add npm and license
badges to surface package status at a glance.

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

coderabbitai Bot commented Jun 16, 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: 152ccd36-89cf-4928-8862-cb469d3db267

📥 Commits

Reviewing files that changed from the base of the PR and between 859a832 and fc035d5.

📒 Files selected for processing (1)
  • README.md

Summary by CodeRabbit

Documentation

  • Reorganized README with clearer structure emphasizing zero-dependency architecture and optional typing
  • Added "Precise types (optional)" section with setup guidance and configuration requirements
  • Expanded error handling documentation with detailed error field descriptions and cancellation behavior
  • Updated configuration section with defaults and per-call override examples
  • Added "More" section highlighting key capabilities and linking to examples

Walkthrough

The README.md is rewritten with a zero-dependency/loose-typing-first narrative. The introduction and usage examples are reformatted around dynamic action execution and namespace sugar. A new "Precise types (optional)" section documents the @oomol-lab/connector-types side-effect import pattern and moduleResolution requirements. Configuration documentation is updated with defaults and a using() sub-client example. The error-handling section is rewritten around ConnectorError, isRetryable, and explicit error fields. The "More" section is condensed to a bullet list, and older expanded proxy/catalog/apps prose is removed.

🚥 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, 'readme' as scope, and 'streamline and condense the overview' as subject, and accurately describes the main change.
Description check ✅ Passed The description is directly related to the changeset, providing clear context about restructuring the README to focus on essentials while condensing reference sections.
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

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

@BlackHole1
BlackHole1 merged commit cd84cb5 into main Jun 16, 2026
1 of 2 checks passed
@BlackHole1
BlackHole1 deleted the improve-readme branch June 16, 2026 08:53
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