Skip to content

docs: refresh living docs for ECH observability, quota metrics, and CI gofmt gate#86

Merged
HardcoreMonk merged 1 commit into
mainfrom
docs/refresh-2026-07-19
Jul 19, 2026
Merged

docs: refresh living docs for ECH observability, quota metrics, and CI gofmt gate#86
HardcoreMonk merged 1 commit into
mainfrom
docs/refresh-2026-07-19

Conversation

@HardcoreMonk

Copy link
Copy Markdown
Owner

요약

이번 세션 4개 머지(PR #81–85)로 생긴 상위 living-doc drift를 현행화한다. 각 기능의 기술 문서(observability.md/runbook.md quota절/ADR-0002/CONTEXT)는 머지 시 이미 동기화됐고, 이 PR은 그때 건드리지 않은 인덱스·경계·기여·릴리즈 노트·보안 요약 계열을 맞춘다. docs-only, 동작 변경 없음 — 기존 계약을 문서화할 뿐 바꾸지 않는다.

방법

drift 감사(worker) → 정확한 항목 리스트(must-fix 3 / should-add 8 / optional 2) → 적용 → diff 직접 검증(docs-only, metric 이름 정확, gofmt 명령이 실제 CI 게이트와 일치, 날짜, 이력 블록 미변경).

변경 (11개 docs)

must-fix (3):

  • docs/ADR_INDEX.md — ADR-0002 행을 현행화(OQ8 deprecation cycle 확정 + ECH 관측 metric), 상단 "현행화 기준" 2026-07-13 → 2026-07-19.
  • CONTRIBUTING.md — 테스트 게이트에 gofmt -l . 추가(신규 CI Gofmt 단계 = 새 기여 계약) + go.mod-pinned 툴체인 주의.
  • docs/guides/api-reference.md — canonical Metrics 카탈로그에 ephemera_egress_sni_ech_observed_total 행 추가.

should-add (8): docs/PUBLIC_RELEASE_BOUNDARY.md(ECH 관측 metric 표면 + anvil_scheduler_quota_* aggregate-only 표면), RELEASE_NOTES.md(untagged 작업에 allow_hosts deprecation·ECH 관측·quota metric·CI gofmt 게이트), docs/guides/security-and-resilience.md·docs/operations/security-policy.md(ECH 잔여가 이제 관측 가능), docs/operations/runbook.md(ECH metric 확인 레시피), AGENTS.md(명령어에 gofmt -l .), docs/operations/release-checklist.md(canonical pre-release 게이트에만 gofmt -l . — 이력 dated 스냅샷 미변경).

optional (2): docs/guides/mcp-adapter.md(scheduler metric 열거를 observability.md canonical 참조로), CONTRIBUTING.md go.mod 정확 pin 주석.

정확성 (검증)

  • metric 이름: ephemera_egress_sni_ech_observed_total{proto}, anvil_scheduler_quota_{usage_total,limit_total,tenants_near,tenants_over,tenants_total} — 코드와 정확 일치.
  • gofmt 명령: 문서 3곳 모두 gofmt -l .(실제 ci.yml Gofmt 단계와 동일 — web/ 제외 같은 불일치 없음).
  • 이력 보존: release-checklist는 canonical 블록만 수정, dated 스냅샷 무변경(git diff로 확인).
  • docs-only: .go/.yaml 무변경, gofmt -l . empty.

lifecycle

docs 현행화(유지보수). behavior/architecture/contract/공개 API 변경 없음 — 기존 계약을 문서에 반영만 함.

…I gofmt gate

Bring higher-level living docs current with PRs #81-85: ADR_INDEX ADR-0002 row
(OQ8 deprecation cycle + ECH observability), CONTRIBUTING/AGENTS/release-checklist
gofmt gate, api-reference ECH metric row, PUBLIC_RELEASE_BOUNDARY ECH + quota metric
surfaces, RELEASE_NOTES untagged work, and the ECH-observable note across
security-and-resilience / security-policy / runbook. Doc-only, no behavior change.
@coderabbitai

coderabbitai Bot commented Jul 19, 2026

Copy link
Copy Markdown

Warning

Review limit reached

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

Next review available in: 39 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

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: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 0589adb7-2844-4997-b912-c231f4c2ccda

📥 Commits

Reviewing files that changed from the base of the PR and between 28a38c6 and 54c7c37.

📒 Files selected for processing (11)
  • AGENTS.md
  • CONTRIBUTING.md
  • RELEASE_NOTES.md
  • docs/ADR_INDEX.md
  • docs/PUBLIC_RELEASE_BOUNDARY.md
  • docs/guides/api-reference.md
  • docs/guides/mcp-adapter.md
  • docs/guides/security-and-resilience.md
  • docs/operations/release-checklist.md
  • docs/operations/runbook.md
  • docs/operations/security-policy.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/refresh-2026-07-19

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.

@HardcoreMonk
HardcoreMonk merged commit 2d39130 into main Jul 19, 2026
2 checks passed
@HardcoreMonk
HardcoreMonk deleted the docs/refresh-2026-07-19 branch July 19, 2026 02:42
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