Skip to content

docs(libvmaf): close 5 documentation gaps in public headers - #302

Merged
lusoris merged 1 commit into
masterfrom
docs/libvmaf-public-headers-doc-gaps
May 31, 2026
Merged

docs(libvmaf): close 5 documentation gaps in public headers#302
lusoris merged 1 commit into
masterfrom
docs/libvmaf-public-headers-doc-gaps

Conversation

@lusoris

@lusoris lusoris commented May 30, 2026

Copy link
Copy Markdown
Contributor

Summary

Doc-only sweep of core/include/libvmaf/ closing five audit findings
from the 2026-05-29 MCP tools audit. No semantic or ABI change.

  • libvmaf.h::vmaf_score_at_index — @param order corrected (score
    before index) to match the C signature.
  • libvmaf.h::VmafConfiguration::cpumask — bit layout split per host
    architecture; previously the doc lumped NEON and SSE2 on bit 0 and
    omitted the arm64 SVE2 bit (bit 1). Both arches are now documented
    explicitly.
  • libvmaf.h::VmafConfiguration::gpumask — clarified that any non-zero
    value disables both CUDA and SYCL feature-extractor selection, and
    that HIP is host-pic and not gated by this mask (ADR-0530).
  • libvmaf.h::VMAF_POOL_METHOD_NB — added an inline hazard note: this
    sentinel is a count, not a stable API value; do not switch on it,
    persist it, or pass it across ABI boundaries.
  • picture.h::VmafPicture — added a struct-level doxygen brief plus
    per-field documentation for every member (pix_fmt, bpc, w[3], h[3],
    stride[3], data[3], ref, priv).
  • dnn.h::vmaf_dnn_session_attached_ep — deduplicated the stable EP
    string list (was listing "OpenVINO:CPU" and "OpenVINO:GPU" twice).

Reproducer / smoke test

meson setup build-cpu core -Denable_cuda=false -Denable_sycl=false
ninja -C build-cpu                 # 726 targets compile cleanly
pre-commit run --files \
  core/include/libvmaf/libvmaf.h \
  core/include/libvmaf/picture.h \
  core/include/libvmaf/dnn.h \
  changelog.d/changed/libvmaf-public-headers-docs.md

Inspect the updated comments:

grep -n "cpumask\|gpumask\|VMAF_POOL_METHOD_NB" core/include/libvmaf/libvmaf.h
grep -n "OpenVINO\|CoreML" core/include/libvmaf/dnn.h

ADR-0108 deliverables checklist

  • Research digest — no digest needed: trivial doc-only fix; the
    underlying ABI/runtime behaviour is already captured in ADR-0530 and
    the arm64 cpu.h flag enum.
  • Decision matrix — no alternatives needed: only-one-way fix
    (every finding has a single correct doc statement, verified against
    source).
  • AGENTS.md invariant note — no rebase-sensitive invariants:
    none of the doc text touches an upstream-mirror identifier; the
    fork-specific notes (gpumask + HIP, SVE2) document fork-side runtime
    state, not a load-bearing rebase invariant.
  • Reproducer / smoke test — see the section above.
  • Changelog fragment — changelog.d/changed/libvmaf-public-headers-docs.md.
  • Rebase notes — no rebase impact: doc-comment text only, no
    symbols renamed, no signatures changed.

Test plan

  • meson setup build-cpu core -Denable_cuda=false -Denable_sycl=false
    succeeds.
  • ninja -C build-cpu succeeds for the full 726-target build (doc
    edits do not break preprocessing, codegen, or ABI).
  • pre-commit run --files <each touched file> is green.
  • CI: required-checks aggregator green on PR.

🤖 Generated with Claude Code

@lusoris
lusoris marked this pull request as draft May 30, 2026 14:42
This was referenced May 30, 2026
Closed
Merged
@lusoris
lusoris marked this pull request as ready for review May 31, 2026 13:26
@lusoris
lusoris force-pushed the docs/libvmaf-public-headers-doc-gaps branch from 16eec24 to e6945c4 Compare May 31, 2026 13:26
@lusoris
lusoris merged commit 89853c1 into master May 31, 2026
28 of 29 checks passed
@lusoris
lusoris deleted the docs/libvmaf-public-headers-doc-gaps branch May 31, 2026 13:26
lusoris added a commit that referenced this pull request Jun 3, 2026
@lusoris @claude
docs(libvmaf): doxygen comments on 15 undocumented public C-API entry…
641b734 
… points

Round-2 follow-on to PR #302 (which closed five targeted gap-findings in
libvmaf.h / picture.h / dnn.h). This pass covers the public surfaces that
PR #302 left untouched, focusing on the headers the ffmpeg patch stack,
the upcoming Go/Rust bindings, and the embedded MCP server consume.

Entry points documented:

- feature.h (file was 100 % undocumented):
  - VmafFeatureDictionary (struct doc + ownership-transfer rules)
  - vmaf_feature_dictionary_set
  - vmaf_feature_dictionary_free

- model.h:
  - VmafModelFlags (enum + per-flag semantics)
  - VmafModelConfig (struct + per-field doc)
  - vmaf_model_load
  - vmaf_model_load_from_path
  - vmaf_model_feature_overload (incl. opts_dict ownership transfer)
  - vmaf_model_destroy (incl. do-not-destroy-after-collection-handoff)
  - VmafModelCollection (struct doc)
  - VmafModelCollectionScoreType (enum doc)
  - VmafModelCollectionScore (struct + per-field doc)
  - vmaf_model_collection_load
  - vmaf_model_collection_load_from_path
  - vmaf_model_collection_feature_overload
  - vmaf_model_collection_destroy

- dnn.h:
  - vmaf_dnn_session_close (pair-with-open contract)

Each block documents the negative-errno return convention, NULL-safety,
ownership-transfer semantics, and the destroy-pairing required to avoid
double-free of collection-owned sub-models. No semantic / no ABI change.

Cleanup pass (CLAUDE.md §12 r12 — touched-file lint-clean rule):
the three Netflix-copyright include guards (__VMAF_FEATURE_H__ /
__VMAF_MODEL_H__ / __VMAF_DNN_H__) trip clang-tidy's
bugprone-reserved-identifier check. Renaming them would diverge from
Netflix/vmaf master and break port-only upstream sync (CLAUDE.md §10),
so each #ifndef / #define gets an inline NOLINT citing the upstream-mirror
invariant — the exact pattern ADR-0278 endorses for load-bearing
upstream-parity identifiers.

Build + lint:
- meson setup build-cpu-doc core -Denable_cuda=false -Denable_sycl=false
- ninja -C build-cpu-doc (35 targets touched by header change; clean)
- clang-tidy -p build-cpu-doc on all 3 touched headers: 0 fork-local
  warnings (the 3 reserved-identifier warnings present on master are now
  NOLINT-cited; remaining warnings are in system headers and suppressed).
- pre-commit run --files <all 5 touched files>: green.

ADR-0108 deliverables:
- Research digest: no digest needed — trivial doc-only addition over
  Netflix-stable signatures already covered by the existing reference
  manual.
- Decision matrix: no alternatives needed — only-one-way fix; the
  ownership-transfer text matches the implementation in core/src/model.c
  and core/src/dict.c verbatim.
- AGENTS.md invariant note: no rebase-sensitive invariants — the doc
  text sits above unchanged upstream signatures; future merges from
  Netflix produce tractable 3-way merges. The NOLINT cites name the
  invariant they preserve (upstream-mirror include guards).
- Reproducer / smoke test: see PR body.
- Changelog fragment:
  changelog.d/added/libvmaf-public-header-doc-comments-round2.md.
- Rebase notes: docs/rebase-notes.md updated with a dedicated section.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
lusoris added a commit that referenced this pull request Jun 3, 2026
@lusoris @claude
docs(libvmaf): doxygen comments on 15 undocumented public C-API entry…
3bc3ca2 
… points

Round-2 follow-on to PR #302 (which closed five targeted gap-findings in
libvmaf.h / picture.h / dnn.h). This pass covers the public surfaces that
PR #302 left untouched, focusing on the headers the ffmpeg patch stack,
the upcoming Go/Rust bindings, and the embedded MCP server consume.

Entry points documented:

- feature.h (file was 100 % undocumented):
  - VmafFeatureDictionary (struct doc + ownership-transfer rules)
  - vmaf_feature_dictionary_set
  - vmaf_feature_dictionary_free

- model.h:
  - VmafModelFlags (enum + per-flag semantics)
  - VmafModelConfig (struct + per-field doc)
  - vmaf_model_load
  - vmaf_model_load_from_path
  - vmaf_model_feature_overload (incl. opts_dict ownership transfer)
  - vmaf_model_destroy (incl. do-not-destroy-after-collection-handoff)
  - VmafModelCollection (struct doc)
  - VmafModelCollectionScoreType (enum doc)
  - VmafModelCollectionScore (struct + per-field doc)
  - vmaf_model_collection_load
  - vmaf_model_collection_load_from_path
  - vmaf_model_collection_feature_overload
  - vmaf_model_collection_destroy

- dnn.h:
  - vmaf_dnn_session_close (pair-with-open contract)

Each block documents the negative-errno return convention, NULL-safety,
ownership-transfer semantics, and the destroy-pairing required to avoid
double-free of collection-owned sub-models. No semantic / no ABI change.

Cleanup pass (CLAUDE.md §12 r12 — touched-file lint-clean rule):
the three Netflix-copyright include guards (__VMAF_FEATURE_H__ /
__VMAF_MODEL_H__ / __VMAF_DNN_H__) trip clang-tidy's
bugprone-reserved-identifier check. Renaming them would diverge from
Netflix/vmaf master and break port-only upstream sync (CLAUDE.md §10),
so each #ifndef / #define gets an inline NOLINT citing the upstream-mirror
invariant — the exact pattern ADR-0278 endorses for load-bearing
upstream-parity identifiers.

Build + lint:
- meson setup build-cpu-doc core -Denable_cuda=false -Denable_sycl=false
- ninja -C build-cpu-doc (35 targets touched by header change; clean)
- clang-tidy -p build-cpu-doc on all 3 touched headers: 0 fork-local
  warnings (the 3 reserved-identifier warnings present on master are now
  NOLINT-cited; remaining warnings are in system headers and suppressed).
- pre-commit run --files <all 5 touched files>: green.

ADR-0108 deliverables:
- Research digest: no digest needed — trivial doc-only addition over
  Netflix-stable signatures already covered by the existing reference
  manual.
- Decision matrix: no alternatives needed — only-one-way fix; the
  ownership-transfer text matches the implementation in core/src/model.c
  and core/src/dict.c verbatim.
- AGENTS.md invariant note: no rebase-sensitive invariants — the doc
  text sits above unchanged upstream signatures; future merges from
  Netflix produce tractable 3-way merges. The NOLINT cites name the
  invariant they preserve (upstream-mirror include guards).
- Reproducer / smoke test: see PR body.
- Changelog fragment:
  changelog.d/added/libvmaf-public-header-doc-comments-round2.md.
- Rebase notes: docs/rebase-notes.md updated with a dedicated section.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
lusoris added a commit that referenced this pull request Jun 3, 2026
@lusoris @claude
docs(libvmaf): doxygen comments on 15 undocumented public C-API entry…
5239924 
… points

Round-2 follow-on to PR #302 (which closed five targeted gap-findings in
libvmaf.h / picture.h / dnn.h). This pass covers the public surfaces that
PR #302 left untouched, focusing on the headers the ffmpeg patch stack,
the upcoming Go/Rust bindings, and the embedded MCP server consume.

Entry points documented:

- feature.h (file was 100 % undocumented):
  - VmafFeatureDictionary (struct doc + ownership-transfer rules)
  - vmaf_feature_dictionary_set
  - vmaf_feature_dictionary_free

- model.h:
  - VmafModelFlags (enum + per-flag semantics)
  - VmafModelConfig (struct + per-field doc)
  - vmaf_model_load
  - vmaf_model_load_from_path
  - vmaf_model_feature_overload (incl. opts_dict ownership transfer)
  - vmaf_model_destroy (incl. do-not-destroy-after-collection-handoff)
  - VmafModelCollection (struct doc)
  - VmafModelCollectionScoreType (enum doc)
  - VmafModelCollectionScore (struct + per-field doc)
  - vmaf_model_collection_load
  - vmaf_model_collection_load_from_path
  - vmaf_model_collection_feature_overload
  - vmaf_model_collection_destroy

- dnn.h:
  - vmaf_dnn_session_close (pair-with-open contract)

Each block documents the negative-errno return convention, NULL-safety,
ownership-transfer semantics, and the destroy-pairing required to avoid
double-free of collection-owned sub-models. No semantic / no ABI change.

Cleanup pass (CLAUDE.md §12 r12 — touched-file lint-clean rule):
the three Netflix-copyright include guards (__VMAF_FEATURE_H__ /
__VMAF_MODEL_H__ / __VMAF_DNN_H__) trip clang-tidy's
bugprone-reserved-identifier check. Renaming them would diverge from
Netflix/vmaf master and break port-only upstream sync (CLAUDE.md §10),
so each #ifndef / #define gets an inline NOLINT citing the upstream-mirror
invariant — the exact pattern ADR-0278 endorses for load-bearing
upstream-parity identifiers.

Build + lint:
- meson setup build-cpu-doc core -Denable_cuda=false -Denable_sycl=false
- ninja -C build-cpu-doc (35 targets touched by header change; clean)
- clang-tidy -p build-cpu-doc on all 3 touched headers: 0 fork-local
  warnings (the 3 reserved-identifier warnings present on master are now
  NOLINT-cited; remaining warnings are in system headers and suppressed).
- pre-commit run --files <all 5 touched files>: green.

ADR-0108 deliverables:
- Research digest: no digest needed — trivial doc-only addition over
  Netflix-stable signatures already covered by the existing reference
  manual.
- Decision matrix: no alternatives needed — only-one-way fix; the
  ownership-transfer text matches the implementation in core/src/model.c
  and core/src/dict.c verbatim.
- AGENTS.md invariant note: no rebase-sensitive invariants — the doc
  text sits above unchanged upstream signatures; future merges from
  Netflix produce tractable 3-way merges. The NOLINT cites name the
  invariant they preserve (upstream-mirror include guards).
- Reproducer / smoke test: see PR body.
- Changelog fragment:
  changelog.d/added/libvmaf-public-header-doc-comments-round2.md.
- Rebase notes: docs/rebase-notes.md updated with a dedicated section.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
lusoris added a commit that referenced this pull request Jun 3, 2026
@lusoris @claude
docs: doc-sweep bundle batch-1 (#327 doxygen round 2 + #330 Go test c…
fe9785a 
…overage + #336 state.md row sweep + #383 README badges + #337 ADR-0865 ANSNR) (#529)

* docs(libvmaf): doxygen comments on 15 undocumented public C-API entry points

Round-2 follow-on to PR #302 (which closed five targeted gap-findings in
libvmaf.h / picture.h / dnn.h). This pass covers the public surfaces that
PR #302 left untouched, focusing on the headers the ffmpeg patch stack,
the upcoming Go/Rust bindings, and the embedded MCP server consume.

Entry points documented:

- feature.h (file was 100 % undocumented):
  - VmafFeatureDictionary (struct doc + ownership-transfer rules)
  - vmaf_feature_dictionary_set
  - vmaf_feature_dictionary_free

- model.h:
  - VmafModelFlags (enum + per-flag semantics)
  - VmafModelConfig (struct + per-field doc)
  - vmaf_model_load
  - vmaf_model_load_from_path
  - vmaf_model_feature_overload (incl. opts_dict ownership transfer)
  - vmaf_model_destroy (incl. do-not-destroy-after-collection-handoff)
  - VmafModelCollection (struct doc)
  - VmafModelCollectionScoreType (enum doc)
  - VmafModelCollectionScore (struct + per-field doc)
  - vmaf_model_collection_load
  - vmaf_model_collection_load_from_path
  - vmaf_model_collection_feature_overload
  - vmaf_model_collection_destroy

- dnn.h:
  - vmaf_dnn_session_close (pair-with-open contract)

Each block documents the negative-errno return convention, NULL-safety,
ownership-transfer semantics, and the destroy-pairing required to avoid
double-free of collection-owned sub-models. No semantic / no ABI change.

Cleanup pass (CLAUDE.md §12 r12 — touched-file lint-clean rule):
the three Netflix-copyright include guards (__VMAF_FEATURE_H__ /
__VMAF_MODEL_H__ / __VMAF_DNN_H__) trip clang-tidy's
bugprone-reserved-identifier check. Renaming them would diverge from
Netflix/vmaf master and break port-only upstream sync (CLAUDE.md §10),
so each #ifndef / #define gets an inline NOLINT citing the upstream-mirror
invariant — the exact pattern ADR-0278 endorses for load-bearing
upstream-parity identifiers.

Build + lint:
- meson setup build-cpu-doc core -Denable_cuda=false -Denable_sycl=false
- ninja -C build-cpu-doc (35 targets touched by header change; clean)
- clang-tidy -p build-cpu-doc on all 3 touched headers: 0 fork-local
  warnings (the 3 reserved-identifier warnings present on master are now
  NOLINT-cited; remaining warnings are in system headers and suppressed).
- pre-commit run --files <all 5 touched files>: green.

ADR-0108 deliverables:
- Research digest: no digest needed — trivial doc-only addition over
  Netflix-stable signatures already covered by the existing reference
  manual.
- Decision matrix: no alternatives needed — only-one-way fix; the
  ownership-transfer text matches the implementation in core/src/model.c
  and core/src/dict.c verbatim.
- AGENTS.md invariant note: no rebase-sensitive invariants — the doc
  text sits above unchanged upstream signatures; future merges from
  Netflix produce tractable 3-way merges. The NOLINT cites name the
  invariant they preserve (upstream-mirror include guards).
- Reproducer / smoke test: see PR body.
- Changelog fragment:
  changelog.d/added/libvmaf-public-header-doc-comments-round2.md.
- Rebase notes: docs/rebase-notes.md updated with a dedicated section.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* test(go): expand cmd/vmafx-{controller,server,mcp} coverage

Add unit tests for the lowest-coverage Go cmd/ subpackages identified by
the master-tip workflow audit (Section F). No behavior change.

Coverage deltas (against origin/master tip bbcaa8d):

  cmd/vmafx-controller        18.6% -> 32.4%  (+13.8 pp)
  cmd/vmafx-controller/nodes  80.7% -> 82.5%  (+1.8 pp)
  cmd/vmafx-server            27.5% -> 47.9%  (+20.4 pp)
  cmd/vmafx-mcp                3.5% -> 24.6%  (+21.1 pp)

New test files:

- cmd/vmafx-controller/main_extra_test.go
    405 method-not-allowed on /healthz, /readyz, /v1/score;
    400 invalid-JSON body; 500 scorer-error mapping via a stub vmaf
    binary; runHTTP graceful shutdown bounded by GracefulShutdownTimeout;
    envOr default+override; version().
- cmd/vmafx-controller/nodes/registry_edge_test.go
    Get(unknown), distinct-IDs-for-same-name contract pin,
    Heartbeat updates JobsRunning + advances LastHeartbeat
    (reaper eviction predicate), concurrent Register/Heartbeat under
    -race, defensive-copy assertion on All().
- cmd/vmafx-server/main_extra_test.go
    Same shape as the controller HTTP server tests; pins the PR #300
    bounded-timeout shutdown invariant.
- cmd/vmafx-mcp/impl_test.go
    All arg helpers (strArg, intArg, floatArg, boolArg, hasArg);
    every pure helper (classifySourceResolution, modelResolutionClass,
    resolutionMismatchWarning, inferBackendFromPayload,
    inferBackendFromSym, stripModelExt, toFFmpegPixfmt, pickWorstFrames,
    floatFromAny, roundF, truncate); representative handler error paths
    (handleProbeBackend missing/unknown backend, handleDescribeModel
    missing name, handleVmafScore invalid path / zero dimensions,
    handleCompareModels empty list). Pins the errorResult().IsError ==
    true invariant from project memory (MCP isError must be True so
    clients branch correctly).

Drive-by fix: .gitignore anchored the Go binary-ignore rules with a
leading slash so they only match the repo-root binaries, not any path
component sharing the name. Without this, untracked files like
cmd/vmafx-server/main_extra_test.go were silently ignored by `git add`.

Verification:

  go test -race -cover ./cmd/vmafx-controller/... \
                      ./cmd/vmafx-server/...     \
                      ./cmd/vmafx-mcp/...
  go vet  ./...

All green; no behavior change. The pre-existing
cmd/vmafx-operator/internal/controller failure (kubebuilder envtest
needs etcd binaries on PATH) is unrelated to this change and reproduces
on a clean origin/master checkout.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* docs(state): reconcile 2 Open rows that cited CLOSED PRs (#214, #215)

Two Open rows in docs/state.md cited PRs that were CLOSED-not-merged
and flagged as follow-up by the PR #291 closing agent. Verified
against master tip bbcaa8d and master state of the underlying
issues:

1. T-CUDA-FILTER1D-RES-DISPATCH-CONFLICT-2026-05-29 — migrated from
   Open to Recently closed (superseded). The conflict markers only
   existed on the unmerged scaffold branch tip 35a1fb6. PR #91
   (merged 2026-05-29T09:37:48Z) landed ADR-0753 resolution-aware
   dispatch via the adm_cm_device() consumer without extending
   dispatch into filter1d_8(), so master never carried the
   build-failing scaffold variant. PR #214 (the planned
   conflict-marker cleanup) was CLOSED-not-merged 2026-05-30 when
   its base scaffold branch was abandoned. core/src/feature/cuda/
   integer_vif_cuda.c::filter1d_8() on master uses the clean
   unconditional cuLaunchKernel paths.

2. T-CPP23-READ-JSON-MODEL-PENDING-2026-05-29 — kept Open but the
   dead PR #215 citation removed. The C++23 Wave 8 conversion of
   core/src/read_json_model.c is still pending on master (still a
   .c source per core/src/meson.build:1578); PR #215 was
   CLOSED-not-merged 2026-05-30. Owner field rewritten to
   "Owner-driven; pending fresh PR per ADR-0846 Wave 8".

Scope-coordinated with DRAFT PR #291 (docs/state-md-drift-sync —
already migrates the 3 Vulkan rows + T-LEGACY-RUNNER-ANSNR-BROKEN
+ T-LEGACY-RUNNER-STUB-MISSING). Row 203
(T-LEGACY-RUNNER-STUB-MISSING-2026-05-29) cites closed PRs #213
and #181 as OPEN but is left untouched here since PR #291 already
rewrites it.

Net Open count -1; total T-row count unchanged (153).
No code changes — documentation cleanup only.

Deliverables (ADR-0108):
- no digest needed: state.md hygiene
- no alternatives: only-one-way reconciliation
- no rebase-sensitive invariants
- Reproducer: `gh pr view 214 -R VMAFx/vmafx --json state,mergedAt`
  returns `{"state":"CLOSED","mergedAt":null}`;
  `grep -nE '^(<{7}|={7}|>{7})( |$)' core/src/feature/cuda/integer_vif_cuda.c`
  on master returns empty; `ls core/src/read_json_model.*` returns
  only `.c` and `.h`.
- Changelog: changelog.d/changed/state-md-closed-pr-row-sweep.md
- no rebase impact: docs only

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* chore(meta): README badge audit + Cargo / pyproject repo-metadata sweep

Audit + backfill the fork's repo-metadata surface so cargo / pip /
GitHub all advertise the canonical VMAFx/vmafx URLs:

- README.md: add Rust CI + Go CI workflow badges (both workflows ship
  on master but were not surfaced). All five pre-existing workflow
  badges already point at VMAFx/vmafx and reference real, active,
  master-green workflows; verified via the Actions API. License,
  Conventional Commits, OpenSSF Scorecard, ko-fi badges already
  present.
- Cargo.toml: add [workspace.package] with repository / homepage /
  documentation / license / authors. Both workspace members
  (bindings/rust/vmafx-sys, core/src/feature/rust/tad) switched to
  workspace-inherited metadata so URL drift is impossible across the
  Rust workspace. cargo metadata confirms both crates now expose the
  VMAFx/vmafx URLs.
- pyproject.toml (root, ai/, tools/vmaf-tune, tools/vmaf-roi-score,
  tools/ensemble-training-kit, dev-llm/, mcp-server/vmaf-mcp/): add
  [project.urls] with Homepage / Repository / Documentation / Issues /
  Changelog. All seven fork-authored projects now ship the same URL
  block; the package indexes (PyPI / internal) get a consistent
  repository link.
- deploy/helm/vmafx/Chart.yaml: already correct (home + sources
  already point at VMAFx/vmafx). No change needed.
- changelog.d/fixed/ + docs/rebase-notes.md: deliverables.

Coordination with PR #331 (rebrand sweep): #331 only touches the
line-1 copyright header of two of the seven pyproject files; this
PR adds a new [project.urls] block below — no merge conflict.

Deep-dive deliverables (ADR-0108):
- Research digest: no digest needed: trivial repo-metadata sweep.
- Decision matrix: no alternatives: only-one-way fix (URLs must
  match the rebrand target).
- AGENTS.md invariant: no rebase-sensitive invariants — fork-only
  metadata files, none mirror upstream Netflix.
- Reproducer: `cargo metadata --no-deps --format-version 1 | jq` +
  `python3 -c "import tomllib; tomllib.loads(open('pyproject.toml','rb').read().decode())"`.
- CHANGELOG fragment: changelog.d/fixed/readme-badges-metadata-audit.md.
- Rebase note: added to docs/rebase-notes.md (impact: none, fork-only).

* docs(adr): author ADR-0865 for ANSNR sunset (closes PR #38 ADR-0108 gap)

PR #38 (merged 2026-05-28) removed `float_ansnr` from the C backend
but cited `Parent ADR-0709` in its body — ADR-0709 is the Phase 4b
distributed-platform umbrella and contains zero ANSNR content.
PR #295 + PR #324 inherited the bad cite. No dedicated ANSNR-sunset
ADR existed in tree.

This change:
- Authors `docs/adr/0865-ansnr-sunset-pre-vmaf-metric-drop.md` as the
  missing parent ADR, back-dated to 2026-05-28 (PR #38 merge date) so
  the dependency chain (ADR-0865 -> PR #38 -> ADR-0749 Python sunset)
  is consistent.
- Documents the historical mis-cite in the new ADR's `## Notes`
  section so future readers landing on PR #38 can recover the trail.
  PR bodies on the remote are immutable merge-history and cannot be
  rewritten.
- Adds the index fragment + `_order.txt` row; regenerates
  `docs/adr/README.md` via `scripts/docs/concat-adr-index.sh`.
- Adds `docs/state.md` row (Updated note + Recently-closed entry).
- Adds `docs/rebase-notes.md` entry documenting the rebase invariant
  (upstream still ships `ansnr` extractors; fork must keep deleting).
- Adds `changelog.d/changed/ansnr-sunset-adr-authoring.md` fragment.

In-tree audit confirmed zero `ADR-0709` references mis-cite ANSNR —
all remaining tree-side `ADR-0709` cites correctly point at Phase 4b
distributed-platform content. No tree-side citation fix-up required.

Docs-only PR. No code changes.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* chore(bundle): add changelog fragment for doc-sweep bundle batch-1

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
Co-authored-by: Lusoris <lusoris@pm.me>
@lusoris lusoris added this to the 1.0.0 — First release milestone Sep 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

1.0.0 — First release

Development

Successfully merging this pull request may close these issues.

1 participant

@lusoris