Skip to content

docs(readme): restructure quick start and voice transcription sections#23

Merged
chr1syy merged 1 commit intomainfrom
docs/voice-readme-v2
Apr 27, 2026
Merged

docs(readme): restructure quick start and voice transcription sections#23
chr1syy merged 1 commit intomainfrom
docs/voice-readme-v2

Conversation

@chr1syy
Copy link
Copy Markdown
Collaborator

@chr1syy chr1syy commented Apr 27, 2026

Pure documentation cleanup — no code changes.

Why

Quick start was previously interleaved with the optional Voice Transcription subsection: steps 4 (deploy commands) and 5 (start the bot) lived under voice setup, and the voice section's own numbered list read "1. → 3. → 4. → 5." (a leftover from #18 that flagged this). Users who didn't want voice transcription had no clean numbered path through the quick start.

What

  • Quick start is now a self-contained 1–4 list (install, configure, deploy commands, start).
  • Voice Transcription is a top-level optional section after Quick start, opening with a short behavior description so a reader can decide whether to install the deps before doing so:
    • Only MessageFlags.IsVoiceMessage triggers transcription — bare .ogg uploads route through the normal attachment path.
    • 25 MB voice attachment cap (per fix(voice): only remove bot's own reaction; preserve non-voice attachments #22).
    • Mixed messages (voice + image) are supported: transcript forwarded as text, non-voice attachments downloaded as usual.
    • Missing-dependency fallback: bot starts normally, voice messages forwarded as plain attachments with an advisory.
  • Installation steps add a Linux/Windows note since whisper-cli is not in mainstream package managers there.
  • Dropped the third-party "FM pack" link in favor of the upstream whisper.cpp repo.

Test plan

  • Renders as expected on GitHub (numbered list flows 1→4 in Quick start; 1→3 in Voice Installation).
  • No code changes; no test impact.

🤖 Generated with Claude Code

Quick start was previously interleaved with the Voice Transcription
subsection — steps 4 (deploy commands) and 5 (start the bot) lived under
the optional voice setup, leaving the numbered list reading
"1. → 3. → 4. → 5." (the missing 2 was the symptom that flagged this).

- Quick start is now a clean 1–4 list independent of voice setup.
- Voice Transcription is its own top-level optional section after Quick
  start, with a short behavior description (IsVoiceMessage gating, 25 MB
  size cap, mixed-attachment handling, dependency-missing fallback) so
  users know what they are turning on before they install anything.
- Added a Linux/Windows note for whisper-cli installation since
  whisper-cli is not in standard package managers there.
- Dropped the third-party "FM pack" link in favor of the upstream
  whisper.cpp repository.

No code changes.

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

coderabbitai Bot commented Apr 27, 2026

Warning

Rate limit exceeded

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

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ 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: ec7056bc-de1b-4c87-bbfb-c4c24be7cf0a

📥 Commits

Reviewing files that changed from the base of the PR and between d3e67a9 and 59db8e9.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/voice-readme-v2

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 08b570c into main Apr 27, 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