Repository navigation
docs: synchronize v0.6.1 documentation and landing pages - #111
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 60da1b59a9
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| </div></div></section> | ||
| <section><div class="wrap"><div class="sectionHead"><div class="kicker">Rack master signal path</div><h2>The meters and faders describe the actual shipping Rack path.</h2><p>v0.6.1 does not treat the master console as decorative UI. Input Trim, Output Fader and broadcast telemetry are attached to the generated shipping Rack helper while preserving the isolated-helper architecture.</p></div><div class="grid3"> | ||
| <article class="card"><div class="icon">IN</div><h3>Input Trim before the chain</h3><p>Input Trim defaults to 0.0 dB, is applied before the serial VST3 chain and uses bounded smoothed gain changes. The input L/R meters observe the post-trim signal.</p></article> | ||
| <article class="card"><div class="icon">OUT</div><h3>Output Fader after the chain</h3><p>Output Fader defaults to 0.0 dB and remains authoritative after the chain, including fail-dry output, so deliberate attenuation does not jump back to full level when a wet result is unavailable.</p></article> |
There was a problem hiding this comment.
When the Rack helper misses its IPC deadline, is still completing the previous request, or is unavailable, WinRackBridge::process() returns false without modifying the OBS channel buffers and rack_filter_audio() ignores that result, so OBS emits the original pre-trim/pre-fader audio. Only helper-internal plug-in failures apply the Output Fader to dry audio. This statement therefore promises that deliberate attenuation or mute survives failure modes where it actually jumps back to the unattenuated level; either make the fader authoritative in the OBS-side fallback or qualify all such documentation claims.
AGENTS.md reference: AGENTS.md:L105-L112
Useful? React with 👍 / 👎.
| | Graphical isolated Rack Editor | ✅ Stable | | ||
| | Compact isolated Rack Editor | ✅ Stable | | ||
| | Add / replace / remove / reorder / bypass | ✅ | | ||
| | Input Trim / Output Fader | ✅ Stable, real DSP controls | |
There was a problem hiding this comment.
If a user changes Input Trim or Output Fader and then restarts OBS or the Rack helper, g_rack_master_controls is recreated at its 0 dB defaults, while the Rack session and preset schemas contain no master-level fields. Advertising these controls as stable alongside automatic Rack recall hides that the audible master configuration is lost during normal restart/recovery; persist both values in the automatic session snapshot (and applicable preset state), or clearly withhold/limit the stable claim.
AGENTS.md reference: AGENTS.md:L95-L101
Useful? React with 👍 / 👎.
Summary
Synchronize the public documentation with the complete OBS Safe VST3 Host v0.6.1 release, not only the P9 persistence work.
What was missing
The existing v0.6.1 docs already covered durable working-Rack recall and split-component VST3 state safety, but the public release also includes the merged Rack UX/master work from PRs #105, #107 and #108:
Updated
README.md— complete v0.6.1 feature summary, workflow, stable-scope table and qualification notes.CHANGELOG.md— complete v0.6.1 release notes for Rack UX, master controls, metering, persistence and state safety.docs/index.html— landing-page copy, product cards, Rack master/metering section, topology UX and release-confidence matrix.docs/compatibility.html— support matrix plus authoritative master signal path and metering contract.Scope
Documentation/website only. No runtime, DSP, packaging or protocol changes.