Skip to content

docs: keep product gap baseline free of mutable lifecycle snapshots - #384

Merged
seonghobae merged 4 commits into
mainfrom
fix/product-gap-baseline-live-truth-20260826
Aug 26, 2026
Merged

docs: keep product gap baseline free of mutable lifecycle snapshots#384
seonghobae merged 4 commits into
mainfrom
fix/product-gap-baseline-live-truth-20260826

Conversation

@seonghobae

@seonghobae seonghobae commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Causal defect

The product/technical gap baseline merged from #372 embedded mutable GitHub lifecycle snapshots in a protected static document. That lets a document become stale in the same lifecycle transition that publishes it and can mislead later merge, release, ownership, or readiness decisions.

Protected main is the shipped implementation authority. This PR changes only the static documentation/freshness-contract boundary; it does not make this PR body, a workflow summary, or any recorded SHA/run ID into lifecycle authority.

TDD / repair lineage

  • Test-only dcbd74eaee1c771f7f4bcf2d6724e54fca01b535 introduced the baseline-freshness contract. Its hosted run was superseded before terminal completion, so no terminal RED claim is made from that run.
  • f21bd3ca75d0803823ba83cc88661f8e5b00d584 strengthened the contract after review: it rejects formatted/multiline protected-main SHA and PR-status snapshots, requires the decision-time live-refetch rule, and requires the canonical index to describe the baseline as static rather than live status. Against the then-unchanged index, the new index assertion was intentionally RED.
  • 78d3f447315f85830b26c4bf81bdb5c376f1fcdf aligned docs/README.md with the same static-baseline/live-refetch contract. Exact-head repository CI subsequently proved typecheck, exact coverage, package consumers, demo build, Office matrix, and cross-engine checks on that source generation.

Historical or predecessor workflow/review results are lineage only and never transfer to a later head.

Live acceptance rule

Do not infer current merge/release readiness from this body. Immediately before any merge, release, readiness, closure, or ownership decision, independently refetch at least:

  • protected main and the exact PR head/live base plus ancestry/mergeability;
  • all open Inkspan PRs/issues relevant to the ownership/dependency boundary;
  • formal reviews and unresolved review threads;
  • required repository and organization workflows, including individual jobs and their actual checkout SHAs;
  • live branch/ruleset protection and required-review policy;
  • releases/tags and any applicable package/SBOM/provenance/reproducibility evidence.

Pending, queued, skipped, cancelled, absent, neutral, failed, stale, predecessor, wrong-checkout, synthetic-source-only, status-only, or model-only evidence is non-passing. Automated comments/reviews are technical input, not qualifying independent approval. Any head/base/ruleset movement invalidates the corresponding decision evidence.

Ownership

This follows the merged #372 documentation owner and is limited to:

  • docs/product-technical-gap-baseline.md;
  • docs/README.md canonical-index wording needed to keep that contract coherent; and
  • the machine-checkable freshness test.

It does not move transport, authentication, tenancy, durable persistence, credentials, migration, retention, deployment, durable audit, Yjs authority, model policy, durable PDF authority, or release authority into Inkspan. If another active writer begins touching this exact documentation boundary before integration, reconcile ownership before further source mutation rather than racing it.

@coderabbitai

coderabbitai Bot commented Aug 25, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

제품 기술 기준선을 날짜 기반 운영 스냅샷에서 보호된 정적 기준선으로 변경했다. 실시간 GitHub 증거 조회 규칙, 제품 경계, P0–P2 수용 기준, 결함 조사와 릴리스 종료 조건을 추가했다. 최신성 계약을 검증하는 Vitest 테스트도 추가했다.

Changes

제품 기술 기준선

Layer / File(s) Summary
정적 기준선과 증거 최신성
docs/product-technical-gap-baseline.md, src/productTechnicalGapBaselineFreshness.test.ts
문서는 보호된 main과 실시간 GitHub 증거를 권위 있는 기준으로 정의한다. 제품과 호스트의 책임 경계를 구분한다. 테스트는 mutable 상태와 필수 생명주기 상태를 검증한다.
우선순위와 수용 기준
docs/product-technical-gap-baseline.md
P0 릴리스, P1 구매자 워크플로, P2 인수 증거 품질의 우선순위와 수용 조건을 정의한다.
결함 조사와 릴리스 종료 규칙
docs/product-technical-gap-baseline.md
변경 전 증거 재조회, 외부 소유자 경로, false-green 조사, 릴리스 수용과 이슈 종료 조건을 정의한다.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: 🔵 Low · up to f9375

The PR removes mutable lifecycle snapshots from the product gap baseline and adds freshness checks. It is mergeable with owner awareness, but the canonical documentation should be aligned and the freshness test strengthened so stale claims cannot bypass validation.

🚥 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 1…
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 제목은 보호된 정적 문서에서 변경 가능한 생명주기 스냅샷을 제거하는 PR의 주요 변경 사항을 정확하고 간결하게 설명합니다.
Full details: Docstring Coverage

Explanation

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 1 files. (1 skipped: 1 unsupported.)

✨ 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 fix/product-gap-baseline-live-truth-20260826

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 ready for review August 25, 2026 16:45
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

coderabbitai[bot]

This comment was marked as resolved.

devin-ai-integration[bot]

This comment was marked as resolved.

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Devin Review found 1 new potential issue.

Open in Devin Review

Comment thread src/productTechnicalGapBaselineFreshness.test.ts

Copy link
Copy Markdown
Contributor Author

@opencode-agent @cwl-noema-review

Review-only request for exact current head 78d3f447315f85830b26c4bf81bdb5c376f1fcdf against independently refetched protected main@057762e003fadad418c38ee748bc3e5b20e711eb.

Please submit only a formal GitHub review bound to that exact head after independently verifying the live diff and current repository contracts. Current review threads are resolved, but the Reviews API has zero APPROVED reviews; COMMENTED/status/model output is not approval. The branch is also behind the live base, so this request confers no merge, auto-merge, branch-write, release, ruleset-bypass, or evidence-transfer authority.

If the head/base moves, treat this request as stale and require fresh exact-head/live-base evidence.

@seonghobae

Copy link
Copy Markdown
Contributor Author

Agreed on the causal defect: embedding mutable lifecycle snapshots in a protected static document makes staleness a publish-time property. The freshness-contract test is the right enforcement boundary. Merging via the organization admin path; the release CHANGELOG consolidation will rebase onto this structure.

@seonghobae
seonghobae merged commit 128a239 into main Aug 26, 2026
33 checks passed
@seonghobae
seonghobae deleted the fix/product-gap-baseline-live-truth-20260826 branch August 26, 2026 00:21
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