Skip to content

docs: A features ledger linked from the README - #1267

Merged
zackees merged 1 commit into
obs-rust:masterfrom
vpacher:docs/1250-features-ledger
Oct 17, 2026
Merged

zackees merged 1 commit into
obs-rust:masterfrom
vpacher:docs/1250-features-ledger

Conversation

@vpacher

@vpacher vpacher commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

Refs #1250

What and why

Features are announced in PRs and then disappear in the stream of merges (discussion #1078). This PR adds the features ledger and the rule that keeps it current. It is the first of two PRs for #1250; the second backfills the PRs that merged before the ledger existed.

This PR:

  1. Adds docs/features.md. Two sections: Features, by area, and Fixed upstream bugs. One line per feature: what changes for the user, the platforms, the merge date, and the issue and PR links. A follow-up PR adds its link to the existing line. The file explains the format and what counts as user-visible.
  2. Seeds it with features that are already merged: the headless changes from Headless and unattended OBS: what already works in the fork #1078 (frontend: Restore --disable-shutdown-check #810, frontend: Migrate pre-31 settings that lack LastVersion #816, frontend: Log output starts refused while outputs are disabled #818, obs-websocket: Save the scene collection after changes #812), the GPU status light (frontend: GPU acceleration status light (green/yellow/red) in the status bar #846) and GPU: x% label (frontend: GPU: x% readout replaces the GPU status light #1025, Linux), 24-bit ALSA capture (linux-alsa: Capture S24_3LE devices at 24 bits #1104), the faster launch on NVIDIA machines (obs-ffmpeg: Probe each VAAPI device once and skip decode-only drivers #1175 to frontend: Probe the GPUs for the GPU status on a thread at launch #1178) and the Qt 6.8 build (frontend: Build with Qt 6.8 (QString::arg) #1017).
  3. Adds a Features section to the README that links the ledger.
  4. Makes adding the line part of the PR: a rule in coordination.md section 4, a sentence in the obs-worker skill (section 4) and in AGENTS.md, and a checkbox in the PR template. CI, tests, ports with no change in behavior and refactors do not get a line.

The decisions from the claim on #1250: two sections, grouped by area with a merge date per line, plain Markdown for now.

RED → GREEN

Checklist

  • Base is master (or the description starts with a Stacked: note)
  • I claimed the issue, or no one else has an open PR for it
  • Characterization test (if the unit had none), then RED, then GREEN commits (not applicable: docs only)
  • User-visible change: its line in docs/features.md is added or updated (this PR adds the file)
  • (Optional) Local gate passed and the pushed head is stamped; otherwise PR CI runs the full suite
  • Warning or flag changes (-W..., ratchets): built with scripting ON (a flag change under cmake/ or build-aux/ runs the full builds) and cross-checked with clang and MSVC (not applicable: no flag changes)
  • Intentional differences from C listed in the parity test header and rust/README.md (ports) (not applicable: no port)

🤖 Generated with Claude Code

docs/features.md lists what OBS-Studio-Rust does differently from
upstream OBS Studio for a user, by area: features and fixed upstream
bugs, one line per feature with the platforms, the merge date and the
issue and PR links. It starts with the headless changes from discussion
obs-rust#1078, the GPU status light and label, 24-bit ALSA capture, the faster
launch and the Qt 6.8 build; the backfill of all merged PRs follows.

A PR with a user-visible change adds its line in the same PR: the rule
is in coordination.md section 4, the obs-worker skill, AGENTS.md and the
PR template checklist. The README links the ledger.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vpacher
vpacher requested a review from zackees as a code owner October 17, 2026 16:46
@zackees
zackees enabled auto-merge October 17, 2026 16:48
@zackees
zackees added this pull request to the merge queue Oct 17, 2026
Merged via the queue into obs-rust:master with commit ed39483 Oct 17, 2026
23 of 24 checks passed
@vpacher
vpacher deleted the docs/1250-features-ledger branch October 17, 2026 18:03
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.

2 participants