Skip to content

docs: keep README customer-first, move hourly playbook - #33

Open
seonghobae wants to merge 2 commits into
mainfrom
cursor/readme-customer-first-6be8
Open

docs: keep README customer-first, move hourly playbook#33
seonghobae wants to merge 2 commits into
mainfrom
cursor/readme-customer-first-6be8

Conversation

@seonghobae

@seonghobae seonghobae commented Aug 16, 2026

Copy link
Copy Markdown
Contributor

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

  • README now leads with what ThreadWeave is (JWZ/RFC 5256 threading), standalone install plus the existing samples, and host composition (from threadweave import thread_messages for Naruon or another service).
  • The hourly PR / exact-head / writer-boundary / NIM broker / do-not-merge / token-setup section moved to docs/operations/hourly-autonomous-maintenance.md. README keeps one sentence and a link.
  • DOCUMENTATION.md, docs/OPERABILITY.md, docs/TEST_STRATEGY.md, and AGENTS.md point at the new operations document.
  • A documentation contract test keeps the front page from absorbing the playbook again.
  • The documentation index no longer calls Python 3.14 a known gap; that support is implemented-main.

What did not change

  • No library API change.
  • No runtime dependency change.
  • No src/ edits.
  • No ADR: this is not a sibling-checkout or unpublished-import break. Naruon remains the intended composition hub and should import the published package.

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 on c855199:

  • ruff check .
  • python -m compileall -q src tests scripts
  • doctests for collation, dates, headers, and subject
  • coverage run -m pytest -q — 302 passed
  • coverage report — 100% statement and branch on owned production modules
  • python -m build --no-isolation
  • python -m pip check
  • GitHub checks on this branch: required CI matrix 3.10–3.14, package, coverage, Semgrep, CodeQL, Scorecard, Strix, Trivy, OSV, Noema, and OpenCode review succeeded

Do not merge from this product task.

Open in Web Open in Cursor 

Summary by CodeRabbit

  • 문서 개선
    • threadweave 설치 및 호스트 구성 안내를 README에서 더 명확하게 확인할 수 있습니다.
    • 시간별 자율 유지보수 절차를 별도 운영 플레이북으로 제공하며, 실행 환경·검증·실패 시 중단 정책을 설명합니다.
    • 관련 문서 간 연결과 탐색성을 개선했습니다.
    • Python 3.14의 CI 및 패키지 지원 상태를 구현 완료로 갱신했습니다.
    • 운영 절차에서 dry_run 실행을 지원합니다.

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>
@coderabbitai

coderabbitai Bot commented Aug 16, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@seonghobae, you've reached your PR review limit, so we couldn't start this review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: af3f9edf-22cc-4d00-8db9-6280db8bf7b8

📥 Commits

Reviewing files that changed from the base of the PR and between 2559425 and c855199.

📒 Files selected for processing (9)
  • AGENTS.md
  • CHANGELOG.md
  • DOCUMENTATION.md
  • README.md
  • docs/DOCUMENTATION_AUDIT.md
  • docs/OPERABILITY.md
  • docs/TEST_STRATEGY.md
  • docs/operations/hourly-autonomous-maintenance.md
  • tests/test_architecture_documentation.py
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cursor/readme-customer-first-6be8

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.

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>
@seonghobae
seonghobae marked this pull request as ready for review August 17, 2026 17:19
@cursor

cursor Bot commented Aug 17, 2026

Copy link
Copy Markdown

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.

@seonghobae

Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown
⚠️ Action not completed

Review rate limited.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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.

2 participants