Skip to content

docs: refresh public README and Pages navigation - #908

Draft
seonghobae wants to merge 23 commits into
mainfrom
docs/public-surface-deepwiki
Draft

seonghobae wants to merge 23 commits into
mainfrom
docs/public-surface-deepwiki

Conversation

@seonghobae

@seonghobae seonghobae commented Sep 1, 2026 •

Copy link
Copy Markdown
Contributor

Outcome

Refresh the public repository/Pages surface around LineageWeave's actual product responsibility while keeping evidence, license, and canonical-owner boundaries explicit. The root README/public landing becomes product-first, operator detail remains in its authoritative docs, publication fails closed when the source landing is absent, and repository-owned hosted jobs are pinned to an explicit supported image.

This PR does not introduce a release, customer, production deployment, benchmark superiority, certification claim, psychometric/statistical ownership, or model/provider routing implementation. TEPP/fast-mlsirm and contextual-orchestrator remain canonical owners.

Protected-main conflict repair

Fresh review 5116251331 found a real convergence conflict after protected #931: #908 and current main both modify Tests, PROV-O, and Ontology Pages workflows for different valid reasons. #908 needs explicit ubuntu-24.04 runners plus public-landing publication paths/tests; #931 needs ready_for_review/converted_to_draft, same-PR cancellation, and draft == false admission. Neither contract may be dropped.

Realistic RED 01895d1b9cd37e8c625e28daadedf2a6a395840e first merged the exact protected #931 workflow/contract blobs while retaining #908's structural hosted-runner regression. That deliberately made the branch's tests/test_github_hosted_runner_contract.py fail because the protected workflows still declared ubuntu-latest.

Causal convergence then combined both contracts:

The branch now contains protected main@83eba56149eb802cd63642c507c324c9976ec78e with no history rewrite and no gate weakening. The public README/Pages/test delta is preserved.

Commercial-license prerequisite

Issue #910 remains the policy blocker for public-surface integration: the reachable psycopg2-binary LGPL-family path must be removed/replaced rather than hidden by attribution or a license exception. PR #911 is the active pg8000 replacement lane and is now Ready on its unchanged exact head for current-head validation; #908 must not land before that prerequisite is normally merged and the protected line is re-verified license-clean.

Exact live boundary

  • protected base: main@83eba56149eb802cd63642c507c324c9976ec78e
  • exact current head: 00e90e03ae1afb7f13ae843dd578694d0f72b325
  • live compare: protected main is the merge base and the branch is behind_by=0
  • PR: open / Draft / mechanically mergeable
  • repository-local Tests 33902990145 and PROV-O 33902990140: completed skipped under Draft admission
  • Ontology Pages 33902990079: both exact-head jobs completed skipped; GitHub resolved their runner labels as ubuntu-24.04 without allocating a runner
  • central SAST 33902990095, CodeQL 33902990162, Security 33902990087: terminal cancelled with no exact-head GREEN verdict
  • exact-head product/release GREEN: not claimed
  • qualifying independent current-head APPROVE: not established in this convergence step

Keep Draft behind #911 and current-head governance. Do not transfer predecessor checks/reviews, weaken license inventory, or publish/release from this head.

@coderabbitai

coderabbitai Bot commented Sep 1, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: f74b7b8c-f5ca-41a2-a0fa-07cce450b4ef

📥 Commits

Reviewing files that changed from the base of the PR and between 35b226b and 032a991.

📒 Files selected for processing (2)
  • README.md
  • tests/test_github_hosted_runner_contract.py
🚧 Files skipped from review as they are similar to previous changes (2)
  • tests/test_github_hosted_runner_contract.py
  • README.md

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


📝 Walkthrough

Walkthrough

LineageWeave에 정적 공개 랜딩 페이지를 추가했습니다. 게시 스크립트는 랜딩 페이지를 검증하고 index.html로 복사합니다. 테스트와 CI는 복사 결과, 누락된 소스, 링크, 변경 감지와 고정된 실행 환경을 검증합니다.

Changes

공개 랜딩 페이지와 프로젝트 설명

Layer / File(s) Summary
정적 랜딩 페이지와 프로젝트 설명
docs/index.html, README.md
docs/index.html에 프로젝트 소개, 탐색 링크, evidence boundary와 라이트·다크 스타일을 추가했습니다. README에 DeepWiki 링크, 제품 스택, 아키텍처, 보안 경계와 문서 지도를 추가했습니다.

랜딩 페이지 게시 및 검증

Layer / File(s) Summary
랜딩 페이지 게시와 테스트 검증
scripts/publish_ontology_site.py, tests/test_public_landing.py, tests/test_publish_ontology_site.py
게시 스크립트가 docs/index.html의 존재와 파일 형식을 확인한 뒤 출력 디렉터리의 index.html로 복사합니다. 테스트는 바이트 단위 복사, 필수 링크와 누락된 소스에 대한 실패 동작을 검증합니다.

CI 트리거와 실행 환경 검증

Layer / File(s) Summary
워크플로 트리거, 테스트 대상과 실행 환경
.github/workflows/ontology-pages.yml, .github/workflows/prov-o-contract.yml, .github/workflows/tests.yml, tests/test_github_hosted_runner_contract.py
docs/index.html과 tests/test_public_landing.py 변경을 감지합니다. validate 및 publish 작업에서 새 테스트를 실행하고, validate에서 해당 파일을 컴파일합니다. 지정된 워크플로 작업은 ubuntu-24.04를 사용하며 계약 테스트가 이를 구조적으로 검증합니다.

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

Sequence Diagram(s)

sequenceDiagram
  participant GitHub Actions
  participant publish_site
  participant landing_source
  participant output_index_html
  GitHub Actions->>publish_site: 게시 작업 실행
  publish_site->>landing_source: docs/index.html 검증
  publish_site->>output_index_html: 랜딩 페이지 복사
  output_index_html-->>GitHub Actions: 게시 결과 생성
Loading

Merge Risk: ⚪ Minimal · up to 032a9

This refresh updates public documentation, Pages navigation, and explicit hosted-runner declarations without supplied evidence of a concrete correctness, security, availability, or deployment risk; no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 42.86% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 7 functions across 4 files. (1 skipped: 1… Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
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 개편과 Pages 탐색 경로 변경이라는 주요 변경 사항을 정확하고 간결하게 설명합니다.
Full details: Docstring Coverage

Explanation

Docstring coverage is 42.86% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 7 functions across 4 files. (1 skipped: 1 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/public-surface-deepwiki

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 added the documentation Improvements or additions to documentation label Sep 1, 2026 — with ChatGPT Codex Connector
devin-ai-integration[bot]

This comment was marked as resolved.

@seonghobae
seonghobae enabled auto-merge (squash) September 1, 2026 13:47
@opencode-agent
opencode-agent Bot disabled auto-merge September 1, 2026 13:48
@seonghobae
seonghobae enabled auto-merge (squash) September 1, 2026 14:14
@opencode-agent
opencode-agent Bot disabled auto-merge September 1, 2026 15:56
github-advanced-security[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

devin-ai-integration[bot]

This comment was marked as resolved.

Preserve the branch's explicit ubuntu-24.04 runner declarations while adopting protected main #923's docs-only Tests trigger filters.
@seonghobae
seonghobae marked this pull request as draft September 3, 2026 04:52
Adopt #924's restored documentation-contract test triggering while preserving this branch's explicit ubuntu-24.04 hosted-runner declarations and public-surface delta.

@seonghobae seonghobae left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fresh protected-main review found a real convergence conflict, not a reason to close this PR. #908 modifies the same three repository-owned workflows that protected #931 later changed for Draft admission. GitHub now reports the PR non-mergeable. The valid #908 deltas are explicit ubuntu-24.04 runner pinning plus public-landing publication paths/tests; the valid protected deltas are ready_for_review/converted_to_draft handling, same-PR cancellation, and draft == false job admission. Neither side may be dropped. Repair must reconstruct the workflows with both contracts, preserve the public README/Pages/test delta, and retain protected tests/test_tests_workflow_contract.py. Pre-#931 hosted evidence does not transfer.

Merge the protected #931 workflow/contract blobs into the public-surface branch without dropping the branch's structural hosted-runner regression. This intentionally leaves the runner contract RED (`ubuntu-latest` vs required explicit `ubuntu-24.04`) so the follow-up can combine both valid contracts instead of choosing one side of the conflict.

Copy link
Copy Markdown
Contributor Author

2026-09-12 repository-facing exact audit

This existing PR is the canonical source writer for the remaining LineageWeave public-surface delta; no duplicate writer was created.

  • protected main@83eba56149eb802cd63642c507c324c9976ec78e
  • exact PR head 00e90e03ae1afb7f13ae843dd578694d0f72b325
  • mechanical mergeability: true
  • current diff: 10 files / 23 commits
  • exact DeepWiki badge is present in this head:
    [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/ContextualWisdomLab/LineageWeave)
  • protected docs/index.md already exists; this head further refreshes the landing/navigation
  • unresolved review threads: 0

Live repository-facing settings remain has_pages=true and homepage=null. Pages enablement alone is not an HTTP publication or homepage-convergence claim. The exact-head Ontology Pages/Tests/PROV-O jobs are skipped and Security/Semgrep/CodeQL are cancelled while this PR remains Draft, so no merge/Ready or publication completion is claimed here.

After ordinary protected-main integration, the central .github metadata reconciler should set/re-read the homepage and verify the published HTTPS content separately.

Copy link
Copy Markdown
Contributor Author

2026-09-20 public-surface dependency readback

Exact head remains 00e90e03ae1afb7f13ae843dd578694d0f72b325, ahead 23 / behind 0, mechanically mergeable, Draft, with 10 changed files and no unresolved review thread. The README carries the exact ContextualWisdomLab DeepWiki badge and docs/index.html carries the canonical https://contextualwisdomlab.github.io/LineageWeave/ landing. These source artifacts are not yet on protected main.

The three central exact-head runs previously described as queued are terminal cancelled: SAST 33902990095, CodeQL 33902990162, Security 33902990087. Repository-local Draft-admitted runs remain skipped. No exact-head GREEN settlement or independent APPROVED review is established.

Central desired-state PR ContextualWisdomLab/.github#2110 now has an explicit reviewed workflow-path contract for this repository's existing .github/workflows/ontology-pages.yml; it remains fail-closed behind this protected-source prerequisite and does not claim live publication. The conflicting type: docs alias was removed; canonical labels are documentation / priority: medium / status: blocked.

@seonghobae seonghobae left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Foreign publication consumer ContextualWisdomLab.github.io#245에서 유효한 owner-path gap이 드러났습니다. 현재 protected main@83eba56149eb802cd63642c507c324c9976ec78e의 scripts/build_ontology_site.py::_render_ontology_page()가 ontology index.html을 deterministic generated artifact로 소유하지만, 생성 <head>에는 CSP/referrer policy contract가 없습니다. #245는 생성된 복사본만 직접 수정하고 있어 다음 canonical regeneration에서 사라질 수 있습니다. Public Pages/workflow/test surface를 소유하는 이 #908 또는 명시적 LineageWeave successor가 causal owner에서 수리해야 합니다.

RED는 protected generator를 그대로 실행한 생성 결과가 합의된 security meta contract를 만족하지 못하는 것을 tests/test_ontology_site.py/publication fixture에서 재현하십시오. GREEN은 _render_ontology_page() 또는 그 canonical template가 정책을 생성하고, source→generated artifact→manifest→publish가 deterministic하게 이어지는 것입니다. Inline stylesheet가 현재 generator 계약이므로 CSP 세부값은 owner threat model과 실제 페이지 resource graph에 맞춰 최소 권한으로 정하십시오. consumer #245의 require-trusted-types-for 'script' 주장처럼 source와 불일치하는 directive를 무작정 복사하지 말고, script-src 'none'과 실제 sink/resource 요구에 근거해 contract를 정해야 합니다.

Acceptance는 generator unit test만으로 끝나지 않습니다. #911 등 기존 prerequisite를 정상 통합한 뒤 exact protected owner head에서 ontology build/publish checks와 security checks를 다시 획득하고, 실제 GitHub Pages가 그 exact generated blob을 제공하는지 HTTP/source digest까지 검증하십시오. 그 이후 GitHub.io downstream copy가 같은 bytes/contract를 소비하도록 versioned publication provenance를 연결해야 합니다. #245의 valid test/CHANGELOG/rationale를 owner successor가 완전 승계하기 전에는 #245를 단순 Close하지 마십시오.

Severity도 causal evidence에 맞춰야 합니다. 현재 확인된 것은 CSP 부재라는 defense-in-depth gap이며, exploitable content-injection primitive나 executable sink가 별도 RED로 입증되지 않은 상태에서 MEDIUM XSS라고 고정해서는 안 됩니다. injection 경로를 재현하지 못하면 hardening으로 doctoring하는 편이 맞습니다. 현재 owner gate: generator source authority FAIL / deterministic security contract FAIL / Pages exact-publication evidence FAIL.

This branch has not been deployed

No deployments
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 status: blocked

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants