docs: keep README customer-first, move hourly playbook - #33
Conversation
Move hourly PR, exact-head, writer-boundary, NIM broker, and token-setup procedure out of the package front page into an internal operations document so customers and host integrators see standalone install and the published thread_messages API first. Co-authored-by: Seongho Bae <seonghobae@users.noreply.github.com>
|
Warning Review limit reached
Next review available in: 14 minutes Limit details: You’ve used all 1 included review currently available under your plan. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. 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: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (9)
✨ Finishing Touches📝 Generate docstrings
🧪 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 |
Keep the README heading-free of autonomous-maintenance playbook text, list the operations playbook in the documentation-contract inventory, and correct the stale Python 3.14 known-gap claim in the index. Co-authored-by: Seongho Bae <seonghobae@users.noreply.github.com>
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
|
@coderabbitai review |
|
Summary
The root README was becoming an agent/CI playbook. This change keeps ThreadWeave independently operable (
pip install threadweave) and composable through the published library API, and moves hourly autonomous-maintenance procedure out of the customer/operator front page.What changed
from threadweave import thread_messagesfor Naruon or another service).docs/operations/hourly-autonomous-maintenance.md. README keeps one sentence and a link.DOCUMENTATION.md,docs/OPERABILITY.md,docs/TEST_STRATEGY.md, andAGENTS.mdpoint at the new operations document.What did not change
src/edits.Residual risk
Documentation-only. The hourly workflows themselves are unchanged; only their customer-facing placement moved.
Verification
Local AGENTS.md verification on
fc23e03, plus focused documentation-contract tests onc855199:ruff check .python -m compileall -q src tests scriptscoverage run -m pytest -q— 302 passedcoverage report— 100% statement and branch on owned production modulespython -m build --no-isolationpython -m pip checkDo not merge from this product task.
Summary by CodeRabbit
threadweave설치 및 호스트 구성 안내를 README에서 더 명확하게 확인할 수 있습니다.dry_run실행을 지원합니다.