docs: make Codec Carver public surface product-first - #516
Conversation
seonghobae
added
documentation
ChatGPT Codex Connector
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughCodec Carver의 README를 제품 중심 안내로 개편하고, CLI와 라이브러리 큐레이션의 고급 운영 문서를 추가합니다. 문서 홈과 MIT 라이선스 파일도 추가합니다. Changes프로젝트 문서
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: 🟡 Moderate · up to This PR changes repository documentation and license packaging metadata rather than runtime behavior, but the current head is not merge-ready because required validation and security checks are still queued; merge should wait until they complete successfully. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
|
Current-head reconciliation note (2026-09-02): this public-surface lane now also completes the source package's existing MIT license declaration with a root |
seonghobae
changed the title
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
![opencode-agent[bot]](https://avatars.githubusercontent.com/in/1549082?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
OpenCode reviewed the current-head product diff. Coverage is a separate gate.
Changed files
LICENSE— repository behaviorREADME.md— repository behaviordocs/advanced-operations.md— operator or user guidancedocs/index.md— operator or user guidancepyproject.toml— repository behavior
Changed behavior
flowchart LR
PR["PR changed files"] --> Evidence["OpenCode bounded evidence"]
Evidence --> S1["Repository file: LICENSE"]
S1 --> I1["repository behavior"]
I1 --> R1["Review risk: Repository file: LICENSE"]
R1 --> V1["required checks"]
Evidence --> S2["Repository file: README.md"]
S2 --> I2["repository behavior"]
I2 --> R2["Review risk: Repository file: README.md"]
R2 --> V2["required checks"]
Evidence --> S3["Docs: advanced-operations.md (2 files)"]
S3 --> I3["operator or user guidance"]
I3 --> R3["Review risk: Docs: advanced-operations.md (2 files)"]
R3 --> V3["docs review"]
Evidence --> S4["Repository file: pyproject.toml"]
S4 --> I4["repository behavior"]
I4 --> R4["Review risk: Repository file: pyproject.toml"]
R4 --> V4["required checks"]
Findings
No source-backed product finding is synthesized from the coverage gate. A coverage miss belongs in the status comment.
- Head SHA:
8f4fc67004cd834928b342b77a9697003b81ab18 - Workflow run: 34194267969
- Workflow attempt: 1
- Coverage gate:
failure
Review outcome
Coverage is a gate, not the review. This body reviews the changed product files.
Changed-File Evidence Map
flowchart LR
PR["PR changed files"] --> Evidence["OpenCode bounded evidence"]
Evidence --> S1["Repository file: LICENSE"]
S1 --> I1["repository behavior"]
I1 --> R1["Review risk: Repository file: LICENSE"]
R1 --> V1["required checks"]
Evidence --> S2["Repository file: README.md"]
S2 --> I2["repository behavior"]
I2 --> R2["Review risk: Repository file: README.md"]
R2 --> V2["required checks"]
Evidence --> S3["Docs: advanced-operations.md (2 files)"]
S3 --> I3["operator or user guidance"]
I3 --> R3["Review risk: Docs: advanced-operations.md (2 files)"]
R3 --> V3["docs review"]
Evidence --> S4["Repository file: pyproject.toml"]
S4 --> I4["repository behavior"]
I4 --> R4["Review risk: Repository file: pyproject.toml"]
R4 --> V4["required checks"]
OpenCode Review Overview
Coverage evidence did not pass, so approval is blocked. The formal pull-request review is the source-backed diff review, not this status comment. |
Pull request was converted to draft
1 participant
Outcome
Make Codec Carver's repository-facing documentation one coherent product-first public surface without discarding the detailed operator knowledge that previously dominated the root README.
README.mdleads with product responsibility, user workflows, source/mutation safety, verification, documentation, and licensing;https://deepwiki.com/ContextualWisdomLab/codec-carver;docs/advanced-operations.md, including GPU/MLX/CUDA, iCloud/File Provider, TMK/VAD, backend-pinning, transcription, review-description, staging, and low-disk procedures;docs/index.mdis a compact documentation/Pages source landing and explicitly does not claim publication;LICENSEmakes the existing MIT source grant explicit;pyproject.tomlincludeslicense-files = ["LICENSE"], so built setuptools artifacts carry that license file.Product and commercial boundary
Codec Carver converts long recordings into metadata-preserving, size/duration-bounded media artifacts and provides evidence-aware recording-library inventory, transcription, duplicate-quarantine, and TMK/transcript reconciliation tooling. Source recordings remain authoritative and generated output stays separate.
Codec Carver-authored source is MIT-licensed, but the current conversion/probing path requires FFmpeg/FFprobe. FFmpeg builds can carry LGPL/GPL-family obligations outside ContextualWisdomLab's supported commercial inbound baseline. Issue #513 owns replacement of that execution boundary. Until that replacement is integrated and released, this PR does not present the FFmpeg-backed path as a commercially approved deployment and does not treat process/container separation as a license exception. Optional packages, native runtimes, models, weights, and provider services retain their own terms.
Preservation and overlap reconciliation
This branch is the canonical repository-facing writer. Compared with overlapping #514, it preserves the long operator material instead of deleting it and also carries #514's valid unique deltas: explicit FFmpeg commercial-boundary documentation and package-artifact inclusion of the root license.
The public-surface delta does not change production algorithms, package version, release, deployment, or repository Pages settings. The causal CI repair updates only the fuzz/test dependency lock and its support documentation after exact coverage evidence proved that Python 3.14 could not install
atheris==3.0.0.Exact-head repair evidence — 2026-09-08
main@47c6fd27de13b0da37a7db64697b869941909351;8f4fc67004cd834928b342b77a9697003b81ab18had repository CI33617279835, fuzz33617279887, SAST33617279942, and Security33617279959GREEN;34194267969, job101968267033, failed before tests because its Python 3.14 environment could not install the protected-baseatheris==3.0.0lock;f42925ad049e30c24b81b4035a9e85fc5c3f944dpins official Atheris 3.1.0 Python 3.12/3.13/3.14 Linux wheel digests and removes stale 3.6–3.12 support claims;b98d6766e24a9bb476c9fe3dca647724ca16c0a4, a two-parent merge preserving the repair andmain's CI queue-concurrency contracts;ec5e11f…and315a0b5c…;git diff --checkpassed;atheris-3.1.0wheel identifies its own name/version, carriesLicense-File: LICENSE, and bundles the Apache License 2.0 text; no GPL/LGPL/AGPL or noncommercial dependency was introduced;632tests with1failure and78skips; the same test fails unchanged at predecessor head only in this root container because UID 0 is an explicitly approved executable owner while the test mocksgetuid()to 1, so it is recorded rather than hidden;34204242014and all three serialized fuzz shards in34204242035are GREEN; every hosted Atheris installation used the new hash-pinned lock;34204241978and SAST34204242027are GREEN;34204242029remains terminal failure. Central exact-head dispatch34207175321completed both actions/python scans withCODEQL_SARIF results=0 medium_plus=0, but cross-repository status publication failed for both configured credentials with HTTP 403 and no Actions-capable wake credential was available. This is clean scan evidence plus an unresolved.githubpublication/wake defect tracked in #1929, not a Codec Carver source finding; no source-neutral rerun or predecessor verdict is used;Merge only through ordinary protected governance after the unchanged exact head has terminal required checks, current review/thread state is clean, and the then-live ruleset permits integration. Do not treat
docs/index.mdsource presence as GitHub Pages publication evidence.Summary by CodeRabbit