Skip to content

docs: point Go Reference badges at /v2 import path#84

Merged
theogravity merged 2 commits into
mainfrom
docs/badge-v2
May 3, 2026
Merged

docs: point Go Reference badges at /v2 import path#84
theogravity merged 2 commits into
mainfrom
docs/badge-v2

Conversation

@theogravity
Copy link
Copy Markdown
Contributor

The README and the docs site's nav both linked the Go Reference badge to pkg.go.dev/go.loglayer.dev (no /v2). pkg.go.dev shows the latest tag at that import path, which is v1.7.0 (the last v1 release before the v2 cascade). The badge therefore showed v1.7.0 even though the live module path is go.loglayer.dev/v2 and the latest release is v2.1.0.

Two commits

  1. Root README + VitePress nav badge image URL and click-through link both get /v2.
  2. Sub-module READMEs (11 transports + plugins/oteltrace) get the same fix. The eight other sub-modules don't ship per-package READMEs; their badges in the docs site's transport-list.md and plugin-list.md partials already use /v2 correctly.

Verification

  • cd docs && bun run docs:build clean (verified before each push).
  • After merge, every Go Reference badge across the project resolves to the v2 module's pkg.go.dev page and shows the v2.x version.

🤖 Generated with Claude Code

theogravity and others added 2 commits May 3, 2026 03:18
The README header and the docs site's nav both linked the Go Reference
badge to `pkg.go.dev/go.loglayer.dev` (no /v2 suffix). pkg.go.dev
serves whatever the latest tag at that import path is, which is v1.7.0
(the last v1 release before the v2 cascade). The badge therefore
showed v1.7.0 even though the live module path is `go.loglayer.dev/v2`
and the latest release is v2.1.0.

Append `/v2` to both the badge image URL and the click-through link
in README.md and docs/.vitepress/config.ts so the badge resolves to
the v2 module's pkg.go.dev page.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Same fix as the root README: every sub-module README's Go Reference
badge URL was missing the `/v2` suffix on both the badge image and
the click-through link, so pkg.go.dev served the v1 (pre-major-bump)
version of each module.

Twelve READMEs updated:
- transports/{charmlog,datadog,http,logrus,lumberjack,otellog,phuslu,pretty,sentry,zap,zerolog}/README.md
- plugins/oteltrace/README.md

The other sub-modules (transports/blank, transports/cli,
transports/console, transports/structured, transports/testing,
transports/slog, transports/central, transports/gcplogging,
plugins/{datadogtrace,fmtlog,plugintest,redact,sampling}) don't
ship per-package READMEs; their badges in the docs site's
transport-list / plugin-list partials already use /v2 correctly.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@theogravity theogravity merged commit 330c595 into main May 3, 2026
11 checks passed
@theogravity theogravity deleted the docs/badge-v2 branch May 3, 2026 10:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant