docs: split provider-specific docs out of README and add provider-dev guide#37
Conversation
… guide The README had grown to ~250 lines mixing kernel-level info with three chunks of Discord/voice/whisper-specific detail. Split those out: - docs/discord.md (new): bot setup with OAuth invite URL + permissions integer, full DISCORD_* env-var table, slash-command catalogue, runtime behavior, security, troubleshooting. - docs/voice.md (new): whisper.cpp setup for production install and source install, behavior notes, configuration table including the previously-undocumented WHISPER_LANGUAGE. - AGENTS-providers.md (new) + CLAUDE-providers.md symlink: deep-dive guide to the BridgeProvider contract, IncomingMessage / OutgoingMessage / KernelContext shapes (verified against src/core/types.ts), file-layout convention, DB and env conventions, voice-transcription integration pattern, and a shipping checklist for new providers. - README.md: replaced the inline Discord/voice/permissions sections with a Providers table and links. Kept kernel-agnostic content (install, build, tests, migration, data storage). - AGENTS.md: slimmed the Discord-provider file list to a one-liner pointing at docs/discord.md, and replaced the 4-bullet "Adding a new provider" with a TL;DR + link to AGENTS-providers.md. - docs/architecture.md: replaced its duplicate "Adding a new provider" section with a link to AGENTS-providers.md so there's a single source of truth. - .env.example: added WHISPER_LANGUAGE for parity with voice.md (already read by src/core/config.ts, just wasn't documented). No code changes; docs only. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
To continue reviewing without waiting, purchase usage credits in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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 configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (8)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Brings in installer bugfixes (PRs #33-#35), .maestro/ untrack (#36), and the docs split (#37) that landed on main after rc was branched. Conflict resolutions: - Kept rc's queue error-hiding (PR #39) and per-message logger.error. - Kept rc's WAL-checkpoint shutdown alongside main's split DB import. - Combined main's docs split with rc's Slack provider additions in README.md, AGENTS.md, .env.example, install.sh, providers.ts, migrations.ts. - Extended config_complete in maestro-relay-ctl.sh to cover the Slack key set when ENABLED_PROVIDERS=slack.
Summary
The README had grown to ~250 lines mixing kernel-level info with three big chunks of Discord/voice/whisper-specific detail. New file structure:
Refactored existing files:
No code changes; no version bump.
Test plan
🤖 Generated with Claude Code