Skip to content

docs: make README links registry-safe - #352

Draft
seonghobae wants to merge 15 commits into
docs/public-surface-metadatafrom
docs/registry-readme-links
Draft

seonghobae wants to merge 15 commits into
docs/public-surface-metadatafrom
docs/registry-readme-links

Conversation

@seonghobae

@seonghobae seonghobae commented Sep 18, 2026

Copy link
Copy Markdown
Contributor

Canonical public-surface successor

This Draft preserves registry-safe package README links and owns the README-side public wording inherited from #321 without competing with #321's docs/index.md authority.

Exact current topology — 2026-09-20

Predecessor and parent evidence did not transfer; the current exact head has now independently reacquired repository-local CI and Release Acceptance. Absence of review is not approval, and this Draft remains unintegrated branch authority only.

Reality RED → minimum causal repair

Predecessor exact b08218d2... reached a genuine repository-owned RED: CI 35456862486 FAILED while Release Acceptance 35456862455 succeeded. Python 3.12 job 105933589083 reported 1 failed, 1689 passed, 5 deselected, 1 warning. The deterministic failure was tests/test_count_tokens_stdin_documentation.py::test_readme_does_not_claim_retired_sql_provider_authority.

The stale test still required the old literal two-line claim former bundled pg_cron+pgsql-http provider retriever is\nretired. That no longer matched the stronger buyer contract already guarded by tests/test_readme_registry_links.py: fresh initialization no longer creates the retriever, but upgraded volumes can still retain legacy extension/schedule/object state until the preservation-first retirement migration reaches protected main.

Current commit 5cdbd57ab66c39c92c921cf3c88897938a6c61cb is the minimum causal repair. It changes only the stale executable documentation assertion so it now requires the same two-stage truth already expressed by the README and the newer registry-link regression:

  • no historical (or) pg_cron job architecture path;
  • fresh initialization no longer creates the former pg_cron + http provider retriever;
  • existing volumes may still contain those extensions; and
  • the preservation-first retirement migration remains explicit.

The README was not weakened or rewritten to satisfy the stale assertion, and tests/test_readme_registry_links.py was not relaxed.

Writer-census boundary for the repair

The invocation-scoped branch collection was freshly paginated to exhaustion (per_page=100: pages 1 and 2 non-empty, page 3 empty). The historical owner that introduced tests/test_count_tokens_stdin_documentation.py, merged PR #173, is already integrated into protected ancestry and its old fix/count-tokens-stdin-privacy head ref is no longer present. Current documentation owners #321, #353, #229 and #324 do not change this test path; #353 remains an active overlapping writer only for README.md/docs/index.md and is serialized behind #321#352. Current token-counter/diagnostic PRs #343/#344 also own disjoint files.

This repair therefore avoids the actively contested README path and extends the existing canonical #352 lane only with the stale test that directly caused its exact-head RED. No competing source branch was created.

Independent warning owner correction

The predecessor CI's compose_bootstrap/runpy RuntimeWarning is not owned here. Fresh discovery found the existing canonical repair at Draft #252, exact e3668344af050672387ca58e59ea24d23d98e51b, with an effective one-file tests/test_compose_bootstrap.py delta and exact CI 34394437612 / Release Acceptance 34394437587 SUCCESS. Issue #354 now points to #252 and remains open until that stack reaches protected main; this PR does not copy or suppress the warning repair.

Causal public-contract repairs retained

Legacy SQL provider-network retirement

Fresh initialization and upgraded-volume truth are different authorities. This Draft states that fresh initialization no longer creates the former provider-retrieval path; existing volumes can still contain legacy extension/schedule/object state; compatibility image package/preload retention remains transitional; and #103/#184 own preservation-first retirement plus the later image/package/preload removal stage. This does not modify migration, Docker image, preload configuration, schema, or runtime authority.

Secret storage and health diagnostics

SecretStore encryption is conditional on a Fernet key unless require_encryption=True; mandatory migration/key lifecycle remains #121. /healthz is the fixed-name/boolean content-minimal public projection while the current standalone CLI health report remains operator-facing and unprojected; runtime disclosure hardening remains #203.

Registry-safe public links retained

tests/test_readme_registry_links.py requires absolute package-registry-safe links for lifecycle, tenant/RLS, bootstrap/secret/input, legacy-network-retirement, observability, papers, license, and notice destinations. It also protects the secret-storage, health-disclosure, and fresh-init-versus-existing-volume retirement boundaries.

Integration boundary

#321 and #323 remain unintegrated Draft parents despite exact-head repository-local GREEN. #184's repository-local GREEN retirement migration is not protected-main authority and does not authorize removing compatibility image packages/preload. Normal order remains central prerequisite convergence → #233 protected integration → #323#321 → this child normal integration after live governance/review requirements are satisfied → existing-volume retirement integration → later image/package/preload removal with rollback evidence → canonical documentation/release convergence.

Keep Draft while upstream governance/integration prerequisites remain unresolved. No self-approval, source-neutral wake commit, synthetic status, protection weakening, routine administrator bypass, destructive rebase, force update, predecessor/parent evidence transfer, blind rerun, or PR close is authorized.

@coderabbitai

coderabbitai Bot commented Sep 18, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: a0498c08-dcde-4178-a5fc-4d49a79d413f

📥 Commits

Reviewing files that changed from the base of the PR and between 5913c4b and 3c8de84.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

README의 저장소 문서 링크를 GitHub 절대 URL로 변경했습니다. 일부 운영·보안·관측성 문서 링크와 설명을 제거했습니다. 원격 배치 수명주기, 논문, 라이선스 링크를 갱신했습니다.

Changes

README 문서 링크 정리

Layer / File(s) Summary
문서 링크 및 설명 갱신
README.md
원격 배치 수명주기, 논문, 라이선스 링크를 GitHub 절대 URL로 변경했습니다. PostgreSQL 논리 복구, 테넌트 수명주기, CLI 시크릿, 토큰 입력, 레거시 pgsql-http, OpenTelemetry 운영 문서 링크를 제거했습니다.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 3c8de

The PR only updates documentation links and descriptions, with no demonstrated impact on runtime behavior or packaging.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed 제목은 README 링크를 registry-safe하게 변경한 주요 변경 사항을 정확히 설명합니다. 절대 GitHub URL 사용과 내부 문서 링크 제거를 포함하는 변경 목적과 일치합니다.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

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.

@seonghobae
seonghobae marked this pull request as draft September 18, 2026 01:04
@seonghobae
seonghobae changed the base branch from main to docs/public-surface-metadata September 18, 2026 01:05
@seonghobae seonghobae added documentation Improvements or additions to documentation priority: medium Normal-priority or P2 work labels Sep 19, 2026 — with ChatGPT Codex Connector

Copy link
Copy Markdown
Contributor Author

Descendant topology repair: Draft #353 has now been serialized directly behind this exact head instead of competing from protected main. #353 base is docs/registry-readme-links@5cdbd57ab66c39c92c921cf3c88897938a6c61cb; its ordinary two-parent head is ef804b40a6d5be3b44b412dc7fd6b81c04cc763d, and the effective child delta relative to #352 is now only docs/index.md front matter (plus final-newline normalization). README is inherited unchanged from #352. Fresh child CI 35480442238 and Release Acceptance 35480442226 are queued; no evidence is transferred to or from this parent.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation priority: medium Normal-priority or P2 work

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant