Skip to content

docs: refresh kernel/provider docs after v0.3.0#50

Merged
chr1syy merged 1 commit into
mainfrom
docs/post-v0.3.0-sync
Jun 7, 2026
Merged

docs: refresh kernel/provider docs after v0.3.0#50
chr1syy merged 1 commit into
mainfrom
docs/post-v0.3.0-sync

Conversation

@chr1syy

@chr1syy chr1syy commented Jun 7, 2026

Copy link
Copy Markdown
Collaborator

Summary

Post-v0.3.0 doc sync — picks up the contract surface added by the four merged PRs (#46#49) that the docs didn't follow.

  • docs/api.md — 429 row now notes the Retry-After header (seconds) added in fix(bridge): provider-agnostic rate-limit / not-found errors + hardening #47.
  • AGENTS.md + docs/architecture.md — core file lists now include src/core/errors.ts.
  • AGENTS-providers.md — new "Typed errors providers throw" subsection under the BridgeProvider contract, with a kernel-reaction table for RateLimitError / AgentNotFoundError and a pointer to the toRateLimitError helpers in the Discord/Slack adapters. Stale "169 tests at time of writing" figure dropped (current count is 233 and would just keep drifting).

No code changes; doc-only.

Test plan

  • git diff main shows only the four expected files (+15 / −2)
  • All file paths / function names referenced in the new typed-errors section verified against current src/
  • No line-number refs used (chose function-name refs to avoid rot)

Summary by CodeRabbit

  • Documentation
    • Added comprehensive provider error documentation covering typed error behaviors, kernel response handling, and guidance for converting platform-specific units
    • Clarified API rate limiting specifications including retry behavior after failed attempts and Retry-After header format requirements
    • Updated project architecture documentation with detailed error handling module references and error type descriptions

- docs/api.md: note Retry-After header (seconds) on 429 responses
- AGENTS.md, docs/architecture.md: list src/core/errors.ts in core layout
- AGENTS-providers.md: document RateLimitError / AgentNotFoundError contract
  providers must throw, with kernel-reaction table and pointer to the
  toRateLimitError helpers in the Discord and Slack adapters
- AGENTS-providers.md: drop stale "169 tests at time of writing" figure

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: a5ab4f55-508e-4614-b737-76c1bef17a82

📥 Commits

Reviewing files that changed from the base of the PR and between cd30827 and 22b5fbe.

📒 Files selected for processing (4)
  • AGENTS-providers.md
  • AGENTS.md
  • docs/api.md
  • docs/architecture.md

📝 Walkthrough

Walkthrough

This PR documents the typed error handling pattern for the kernel and providers. It adds architectural references to the error module, specifies provider contracts for throwing RateLimitError and AgentNotFoundError, clarifies HTTP 429 retry behavior, and updates testing notes.

Changes

Typed Error Documentation

Layer / File(s) Summary
Error module architecture
docs/architecture.md
Added src/core/errors.ts to project layout, identifying it as the typed errors module.
Kernel error contracts and provider guidance
AGENTS.md, AGENTS-providers.md
Documented RateLimitError and AgentNotFoundError types, their data fields, kernel HTTP behavior, and guidance for normalizing rate-limit units in adapter helpers. Added core errors reference to kernel documentation.
API error specification and testing updates
docs/api.md, AGENTS-providers.md
Clarified 429 HTTP response behavior (3 upstream retries, Retry-After header). Removed outdated test count from testing instruction.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A rabbit hops through docs with care,
Error types now live in air,
Rate-limit paths are crystal clear,
Typed errors guide the way down here. 🐰

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: documentation updates syncing kernel/provider docs following the v0.3.0 release, which aligns with all four modified files' purposes.
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.

✏️ 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/post-v0.3.0-sync

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.

@chr1syy chr1syy merged commit 8424883 into main Jun 7, 2026
3 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