Skip to content

docs: split provider-specific docs out of README and add provider-dev guide#37

Merged
chr1syy merged 1 commit into
mainfrom
docs/split-provider-docs
May 7, 2026
Merged

docs: split provider-specific docs out of README and add provider-dev guide#37
chr1syy merged 1 commit into
mainfrom
docs/split-provider-docs

Conversation

@chr1syy
Copy link
Copy Markdown
Collaborator

@chr1syy chr1syy commented May 7, 2026

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:

New file Contents
`docs/discord.md` Bot setup, OAuth invite URL + permissions integer, full `DISCORD_*` env table, slash commands, runtime behavior, security, troubleshooting
`docs/voice.md` whisper.cpp setup (production + source flows), behavior notes, config table incl. the previously-undocumented `WHISPER_LANGUAGE`
`AGENTS-providers.md` (+ `CLAUDE-providers.md` symlink) Deep-dive provider-development guide: `BridgeProvider` contract, `IncomingMessage` / `OutgoingMessage` / `KernelContext` shapes verified against `src/core/types.ts`, file-layout convention, DB/env conventions, voice-transcription integration pattern, shipping checklist

Refactored existing files:

  • `README.md` — replaced 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`, 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` (single source of truth).
  • `.env.example` — added `WHISPER_LANGUAGE` for parity with `voice.md` (was already read by `src/core/config.ts`, just wasn't documented).

No code changes; no version bump.

Test plan

  • All internal markdown links resolve (manually verified all `*.md` link targets exist)
  • Type signatures in `AGENTS-providers.md` cross-checked against `src/core/types.ts` (`IncomingMessage`, `OutgoingMessage`, `IncomingAttachment`, `KernelContext`, `EnqueueOptions`)
  • Voice-transcription flow in `AGENTS-providers.md` cross-checked against `src/providers/discord/messageCreate.ts` (`contentOverride` + `attachmentsOverride` pattern)
  • CI: lint+test+CodeRabbit on this PR

🤖 Generated with Claude Code

… 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>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 7, 2026

Warning

Rate limit exceeded

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

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 @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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 60e03260-5888-46d4-9168-a559d80d5419

📥 Commits

Reviewing files that changed from the base of the PR and between 747976c and e1b8a0a.

📒 Files selected for processing (8)
  • .env.example
  • AGENTS-providers.md
  • AGENTS.md
  • CLAUDE-providers.md
  • README.md
  • docs/architecture.md
  • docs/discord.md
  • docs/voice.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/split-provider-docs

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 1ed4811 into main May 7, 2026
3 checks passed
@chr1syy chr1syy deleted the docs/split-provider-docs branch May 7, 2026 19:15
chr1syy added a commit that referenced this pull request May 10, 2026
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.
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