Repository navigation
docs: v0.6.0 pre-release audit - #64
Merged
Merged
Conversation
Behavior-neutral docs pass ahead of the v0.6.0 release. - Bump the OpenAPI spec's info.version to 0.6.0. - Document the new --bpm-range flag and the (previously undocumented) --mpris flag in the README flags table. - Point the README's HTTP API section at the OpenAPI spec (/api/openapi.yaml) and the self-hosted Swagger UI (/api/docs), since the hand-listed endpoints are only a quick reference now that the full surface is specified. - Add a Contributors section crediting direct contributors (kayrozen, Evan Purkhiser); per-release reporter/patch credits live in each release's notes. Code is untouched; build, vet, test, and gofmt are green on main, and go mod tidy is a no-op.
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
1 participant
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.
What & why
Behavior-neutral documentation pass ahead of the v0.6.0 release, after draining the merge queue. No code changes.
info.versionto0.6.0.--bpm-rangeflag and the previously-undocumented--mprisflag in the README flags table./api/openapi.yaml) and the self-hosted Swagger UI (/api/docs), since the hand-listed endpoints there are only a quick reference now that the full surface is specified.A field-by-field audit of every spec schema against the serialized Go structs turned up only one real drift (the overlay waveform fields), which merged with #59's follow-up; the spec is otherwise current, so this PR is just the version bump and the README accuracy items.
Hardware testing
Documentation only. Nothing a deck reacts to.
Checklist
go build ./...,go vet ./..., andgo test ./...passgofmt -l .is cleanGPL-3.0-or-later) — N/A, no new source files (README + openapi.yaml, both already headed)