docs: fix Markdown staleness/gaps + add apikey example - #180
Merged
Conversation
- README: delete the stale Roadmap (all of it shipped), drop the third-party shields.io badges (keep the GitHub-native CI + pkg.go.dev badges), fold the feature tags into the pitch text, and add apikey/oauth to the architecture diagram. - docs/validation.md: the email Close() comment described a background goroutine that no longer exists; Close is now an optional no-op. - docs/errors.md: add the auth/apikey and auth/oauth error sections and the jwt.ErrTokenRevoked row (referenced elsewhere but previously unlisted). - docs/configuration.md: document the KeyStore field. - docs/testing.md: add apikey/oauth to the layout tree and the import table, and the oauth/apikey examples. - examples/apikey: add a runnable example for parity with the other modules, and add it to the examples CI matrix. Signed-off-by: Jaro-c <75870284+Jaro-c@users.noreply.github.com>
Jaro-c
added
area:examples
Jaro-c
enabled auto-merge (squash)
June 29, 2026 17:02
Signed-off-by: Jaro-c <75870284+Jaro-c@users.noreply.github.com>
Merged
Jaro-c
added a commit
that referenced
this pull request
Jun 29, 2026
Release v1.10.7 — documentation. One new example, no library code changes. From the Markdown docs review: removed the stale README Roadmap and the third-party shields.io badges, fixed the false email Close() goroutine comment, completed the error reference (apikey/oauth/ErrTokenRevoked), documented the KeyStore config field, added apikey/oauth to the architecture diagram and the testing layout/import table, and added a runnable examples/apikey for parity. (#180)
Jaro-c
added a commit
that referenced
this pull request
Jun 29, 2026
The Markdown review fixes intended for #180 were dropped when a failed `git add` of a non-existent `go.sum` aborted staging — only the apikey example landed. This commits the actual changes: - README: removed the stale Roadmap and the third-party shields.io badges (kept GitHub-native CI + pkg.go.dev; feature tags moved into the pitch); added apikey/oauth to the architecture diagram. - docs/validation.md: the email `Close()` is an optional no-op, not goroutine cleanup. - docs/errors.md: added the apikey and oauth error sections and `jwt.ErrTokenRevoked`. - docs/configuration.md: documented the `KeyStore` field. - docs/testing.md: added apikey/oauth to the layout tree and import table. - examples CI matrix now includes the apikey example. Docs + CI matrix only. Signed-off-by: Jaro-c <75870284+Jaro-c@users.noreply.github.com>
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.
From the Markdown docs review (verdict: marketing surface is captivating and well-sized; defects were staleness and completeness). All findings addressed:
Close()comment described a background goroutine that no longer exists; it is now an optional no-op.auth/apikeyandauth/oautherror sections and thejwt.ErrTokenRevokedrow (referenced by jwt.md/secure-login.md but previously unlisted).apikey/oauthto the architecture diagram.apikey/oauthto the layout tree and import table, plus the oauth/apikey examples.KeyStorefield.Docs + one new example module.
go build,go vet,golangci-lint(0 issues) pass; the apikey example builds in readonly mode.