docs: apply the Markdown review fixes (were dropped from #180) - #182
Merged
Conversation
…g, testing) These doc fixes were intended for #180 but were dropped when a failed 'git add' of a non-existent go.sum aborted the staging — only the apikey example landed. This commits the actual changes: - README: remove the stale Roadmap and the third-party shields.io badges (keep the GitHub-native CI + pkg.go.dev badges; feature tags moved into the pitch), add apikey/oauth to the architecture diagram. - docs/validation.md: the email Close() is an optional no-op, not goroutine cleanup. - docs/errors.md: add the apikey and oauth error sections and jwt.ErrTokenRevoked. - docs/configuration.md: document the KeyStore field. - docs/testing.md: add apikey/oauth to the layout tree and import table. - examples CI matrix: include the apikey example. Signed-off-by: Jaro-c <75870284+Jaro-c@users.noreply.github.com>
Jaro-c
enabled auto-merge (squash)
June 29, 2026 17:09
Merged
Jaro-c
added a commit
that referenced
this pull request
Jun 29, 2026
Release v1.10.9 — documentation. Applies the Markdown review fixes that were accidentally dropped from the v1.10.7/v1.10.8 docs PR (a failed git add aborted staging, so only the apikey example landed): - README: stale Roadmap removed, third-party shields.io badges removed (GitHub-native CI + pkg.go.dev kept), apikey/oauth added to the architecture diagram. - docs/validation.md: email Close() documented as an optional no-op. - docs/errors.md: apikey + oauth error sections and jwt.ErrTokenRevoked added. - docs/configuration.md: KeyStore field documented. - docs/testing.md: apikey/oauth added to the layout and import table. - examples CI matrix includes the apikey example. (#182) Note: v1.10.7 was a mis-tagged no-op (a tag race put it on the v1.10.6 tree); v1.10.8 shipped only the apikey example. This release carries the doc fixes.
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.
The Markdown review fixes intended for #180 were dropped when a failed
git addof a non-existentgo.sumaborted staging — only the apikey example landed. This commits the actual changes:Close()is an optional no-op, not goroutine cleanup.jwt.ErrTokenRevoked.KeyStorefield.Docs + CI matrix only.