docs: sweep user-facing imports to v2 paths#65
Merged
Conversation
Bumps every v1 import path mention in the user-facing docs, README, and LLM reference files to its v2 form. The v2 release shipped the module-path bumps (`go.loglayer.dev` -> `go.loglayer.dev/v2`, `go.loglayer.dev/transports/<X>` -> `go.loglayer.dev/transports/<X>/v2`, etc.); the doc-side sweep was deferred to this PR. New users landing on the homepage / README otherwise copy v1 snippets and silently miss v2 features. Excluded by design: whats-new.md, migrating-to-v2.md, .changeset/*.md, CHANGELOG.md, the docs-site CNAME, the `https://go.loglayer.dev` docs URLs, and the bare `pkg.go.dev/badge/go.loglayer.dev.svg` shield (resolves to latest).
5 tasks
theogravity
added a commit
that referenced
this pull request
May 2, 2026
Follow-up to the v2.0.0 release (#61, #63) and user-facing import sweep (#65) addressing issues surfaced by a four-reviewer documentation pass. Critical: - creating-transports.md: drop stale "already prefix-applied" comment on TransportParams.Messages; the core no longer mutates Messages[0]. - llms.txt / llms-full.txt: add transports/cli to the Renderers catalog and install snippet (shipped at v2.0.0 but was missing from both). - introduction.md: show the lltest "go.loglayer.dev/transports/testing/v2" import alias in the test-capture snippet. Important: - GoDoc cross-references bumped to /v2 in transports/cli/cli.go, transports/otellog/otellog.go, doc.go, examples/pretty-modes/main.go. - migrating-to-v2.md: reframe lede as "two breaking changes" (the import-path bump is its own breaking change); add paragraph on the core no longer mutating caller-owned input; rewrite Step 1 shell snippet so the trailing-backslash + comment paste-trap is gone; add callout for the new testing.LogLine.Prefix field. - configuration.md / llms.txt: reframe the Prefix inline comment so it no longer claims the core prepends. Style: - Em-dash sweep across llms.txt and llms-full.txt (~50 occurrences) per the project's no-em-dashes-anywhere rule. - llms-full.txt: typo "rolled-our-own" -> "roll-our-own"; reframe the "Testing Transport (lltest)" and "Capture entries with lltest" headings since lltest is an alias convention, not the package name. transports/central left undocumented intentionally: its package GoDoc is already correct for v2 and the module is not in monorel.toml or the v2.0.0 release. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.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.
Summary
pkg.go.dev/...#Symbolcross-references), all balanced inserts/deletes.Path-bump map applied
go.loglayer.dev(bare)go.loglayer.dev/v2go.loglayer.dev/transport,go.loglayer.dev/utils/<X>go.loglayer.dev/v2/transport,go.loglayer.dev/v2/utils/<X>go.loglayer.dev/transports/<X>,plugins/<X>,integrations/<X>go.loglayer.dev/transports/<X>/v2(and same forplugins,integrations)go getcommands andpkg.go.dev/...cross-reference URLs (with#Symbolfragments) updated alongside.Excluded by design
whats-new.md(version-history page; v1 mentions are correct context)migrating-to-v2.md(literally documents the bump).changeset/*.md,CHANGELOG.md(release archive)docs/src/public/CNAME(docs site domain, not import path)https://go.loglayer.dev/...URLs (the docs site, not import paths)pkg.go.dev/badge/go.loglayer.dev.svg(the bare-form shield resolves to latest)lumberjack.v2,dd-trace-goHow the sweep was done
A small Python script (with self-tests) handled the substitution. The asymmetry between main-module subpaths (
/v2inserted after.dev) and sub-module paths (/v2appended at the end) made a single regex unsafe; the script applies the two patterns separately and protects docs-site URLs and badge URLs ahead of time. The path-end set covers whitespace, quote, paren, comma, semicolon, period, backslash,#, and EOL so URL fragments and trailing punctuation are handled cleanly. Idempotence verified: a re-run reports zero changes.Test plan
cd docs && bun run docs:buildsucceeds cleangrep -rn "go\.loglayer\.dev" docs/src/ README.md | grep -v <preserved patterns>reports zero remaining v1 mentions🤖 Generated with Claude Code