Skip to content

docs: apply the Markdown review fixes (were dropped from #180) - #182

Merged
Jaro-c merged 1 commit into
developfrom
docs/md-fixes-commit
Jun 29, 2026
Merged

docs: apply the Markdown review fixes (were dropped from #180)#182
Jaro-c merged 1 commit into
developfrom
docs/md-fixes-commit

Conversation

@Jaro-c

@Jaro-c Jaro-c commented Jun 29, 2026

Copy link
Copy Markdown
Member

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.

…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 Jaro-c added area:meta Subsystem: meta effort:S Small prio:P2 Medium priority status:review In review type:docs Documentation labels Jun 29, 2026
@Jaro-c
Jaro-c enabled auto-merge (squash) June 29, 2026 17:09
@Jaro-c
Jaro-c merged commit 0656fda into develop Jun 29, 2026
12 checks passed
@Jaro-c
Jaro-c deleted the docs/md-fixes-commit branch June 29, 2026 17:10
@Jaro-c Jaro-c mentioned this pull request Jun 29, 2026
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:meta Subsystem: meta effort:S Small prio:P2 Medium priority status:review In review type:docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant