Skip to content

fix(docs): clear markdownlint backlog on 6 doc files (cosmetic only) - #711

Merged
lusoris merged 1 commit into
masterfrom
fix/markdownlint-doc-backlog
Jun 6, 2026
Merged

lusoris merged 1 commit into
masterfrom
fix/markdownlint-doc-backlog

Conversation

@lusoris

@lusoris lusoris commented Jun 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Fixes MD013/MD032/MD012/MD004/MD031 markdownlint violations on 6 docs/ADR files
  • Purely cosmetic: line wrapping at 80 chars, blank lines before lists/fences, + bullet → -, remove double blank lines
  • No semantic content changed; all affected ADRs are Accepted

Files changed

File Violations fixed
docs/adr/0787-libvmaf-api-error-path-audit.md MD013 (wrap lines > 80)
docs/adr/0788-doxygen-thread-safety-tags.md MD013 + MD032 (blank before list)
docs/adr/0848-per-surface-doc-compliance-audit.md MD032 (blank before list)
scripts/ci/AGENTS.md MD012 (double blank line)
docs/research/0116-float-adm-avx2-512-f2-f3-precision.md MD004 (plus bullet) + MD031 (blank before fence)
docs/research/research-0848-per-surface-doc-compliance-audit-20260529.md MD013 + MD032

Test plan

  • pre-commit run markdownlint-cli2 --files <all 6 files> → Passed locally

Deep-dive deliverables checklist

  • Research digest: no digest needed: trivial cosmetic lint fix
  • Decision matrix: no alternatives: only-one-way fix
  • AGENTS.md invariant note: no rebase-sensitive invariants
  • Reproducer: pre-commit run markdownlint-cli2 --files docs/adr/0787-libvmaf-api-error-path-audit.md docs/adr/0788-doxygen-thread-safety-tags.md docs/adr/0848-per-surface-doc-compliance-audit.md scripts/ci/AGENTS.md docs/research/0116-float-adm-avx2-512-f2-f3-precision.md docs/research/research-0848-per-surface-doc-compliance-audit-20260529.md
  • Changelog fragment: no changelog needed: internal lint/style fix only
  • Rebase notes: no rebase impact: doc-only cosmetic change

Bug-status hygiene

no state delta: cosmetic lint fix, no bugs opened or closed

🤖 Generated with Claude Code

Fixes MD013, MD032, MD012, MD004, MD031 violations across:
- docs/adr/0787-libvmaf-api-error-path-audit.md (MD013 wrap long lines)
- docs/adr/0788-doxygen-thread-safety-tags.md (MD013 + MD032 blank before list)
- docs/adr/0848-per-surface-doc-compliance-audit.md (MD032 blank before list)
- scripts/ci/AGENTS.md (MD012 double blank line)
- docs/research/0116-float-adm-avx2-512-f2-f3-precision.md (MD004 plus bullet + MD031 blank before fence)
- docs/research/research-0848-per-surface-doc-compliance-audit-20260529.md (MD013 + MD032)

No semantic content changed. All affected ADRs are Accepted; only
cosmetic whitespace and line-wrapping adjustments were made.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@lusoris
lusoris marked this pull request as ready for review June 6, 2026 01:25
@lusoris
lusoris merged commit fa220e0 into master Jun 6, 2026
13 of 14 checks passed
@lusoris
lusoris deleted the fix/markdownlint-doc-backlog branch June 6, 2026 01:25
lusoris added a commit that referenced this pull request Jun 6, 2026
…06 batch (#719)

Refreshes bug-tracking and planning documents after the 18-PR June 5-6 batch
(#691–#711). Changes in docs/state.md (tracked):

- Add batch-sweep _Updated header summarising PRs #691–#711.
- Add T-NEON-FMA-FLOAT-ADM-DWT2-2026-06-06 to Open bugs table (was only in
  the _Updated header, missing from the table body).
- Remove duplicate T-CPP23-READ-JSON-MODEL-PENDING-2026-05-29 row (stale copy
  that cited closed PR #215 as OPEN; the de-cited version is kept).
- Fix concatenated duplicate T-GPU-COVERAGE-STABLE-WEEKS rows in Recently
  closed (two entries were joined on a single line without a separator).
- Add 8 new Recently closed rows for substantive June 5-6 fixes:
  T-NEON-FMA-FLOAT-ADM-DWT2-REVERT (PR #695 revert),
  T-METAL-FEATURE-COLLECTOR-EXTERN-C (PR #694),
  T-SYCL-DICT-INCLUDE-MISSING (PR #696),
  T-INTEGER-SSIM-I686-INCLUDE (PR #700),
  T-WAVE8-OBJ-TARGET-DEPS (PRs #699/#701),
  T-DNN-INT8-TEST-ADR1032-ALIGN (PR #705),
  T-MCP-SMOKE-11-FAILURES (PR #706).

OPEN.md and BACKLOG.md (gitignored, updated in main tree only):
- Header dates updated to 2026-06-06.
- SIMD divergence cluster marked CLOSED (PR #681, 2026-06-04).
- T-NEON-FMA-FLOAT-ADM-DWT2 added to Active right now.
- June 5-6 PR table added to Recently completed sections.
- Awaiting user decision updated: SIMD divergence closed, NEON FMA rewire new.

no rebase impact: docs/state.md only; no C sources touched.

Co-authored-by: Lusoris <lusoris@pm.me>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
@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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant