Shorten the README and move reference material into docs#69
Conversation
The README had grown to 484 lines and duplicated the docs site, which meant it drifted. It is now 116 lines: what podcli does, how to install it, a quick start, and links out. Everything reference-shaped moved to docs/configuration.md or was already covered at podcli.com/docs. Fixed what was wrong along the way: - It claimed 22 MCP tools; the code registers 26, and the table listed 17. The claim is gone, so scripts/check-docs-drift.mjs no longer warns. - The configuration table documented WHISPER_MODEL and WHISPER_DEVICE, which have zero source references. The Whisper model is chosen per run with --model. Also documented LOG_LEVEL, which is really PODCLI_LOG_LEVEL. .env.example carried the same four dead entries (those two, plus DEBUG and LOG_LEVEL) and was the source of the error; they are removed. - PODCLI_HOME does not default to .podcli/. That is only true from source; an installed build uses its managed folder. Same for PODCLI_DATA and PODCLI_OUTPUT. - Project Structure pointed at src/ui/public/ as the frontend. It is src/ui/client/. The tree is dropped rather than corrected, since it rots on every refactor. - "Nothing leaves your machine" overstated it: AI clip scoring calls Claude or Codex. The docs already word this precisely, so the README now matches them.
|
Warning Review limit reached
Next review available in: 22 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
✨ 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 |
The README had grown to 484 lines and duplicated the docs site, so it drifted. It is now 116 lines: what podcli does, how to install it, a quick start, and links out. Everything reference-shaped moved to
docs/configuration.mdor was already covered at podcli.com/docs.Stale claims found and fixed
Checking coverage before deleting turned up real errors, not just verbosity:
scripts/check-docs-drift.mjswas warning about this on every CI run. The claim is gone, so the check is now clean.WHISPER_MODELandWHISPER_DEVICE, which have zero source references anywhere. The Whisper model is chosen per run with--model. It also documentedLOG_LEVEL, which is reallyPODCLI_LOG_LEVEL..env.examplecarried the same four dead entries (those two plusDEBUGandLOG_LEVEL) and was the source of the error, so they are removed there too.PODCLI_HOMEdoes not default to.podcli/. That holds only when running from source; an installed build uses its managed folder. Same forPODCLI_DATAandPODCLI_OUTPUT.src/ui/public/as the frontend. It issrc/ui/client/. The tree is dropped rather than corrected, since it rots on every refactor.Where the content went
Only two things had no home on the docs site, so neither was simply deleted:
docs/configuration.md, corrected against the source.CLAUDE.md, which the README links to.The other five sections map to existing pages: getting started, the studio, CLI, MCP server, captions and formats.
Verification
scripts/check-docs-drift.mjspasses with no warnings (previously warned on the tool count).