Repository navigation
docs: A features ledger linked from the README - #1267
Merged
Merged
Conversation
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>
zackees
approved these changes
Oct 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
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.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).coordination.mdsection 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
ci/test_issue_templates.pypasses. All ofci/test_*.pythroughuv run: the same 7 failures as master on macOS, none new.Checklist
master(or the description starts with a Stacked: note)docs/features.mdis added or updated (this PR adds the file)-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)🤖 Generated with Claude Code