docs: address v2 release review findings#67
Merged
Conversation
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
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
Follow-up to the v2.0.0 release (#61, #63) and the user-facing import sweep (#65), addressing issues surfaced by a four-reviewer documentation pass against the post-v2 docs.
Critical:
creating-transports.md: drop the stale// already prefix-appliedcomment onTransportParams.Messages; the core no longer mutatesMessages[0].llms.txt/llms-full.txt: addtransports/clito the Renderers catalog and install snippet (shipped at v2.0.0 but was missing from both).introduction.md: show thelltest "go.loglayer.dev/transports/testing/v2"import alias in the test-capture snippet.Important:
/v2intransports/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 itself breaking); add a paragraph about the core no longer mutating caller-owned input; rewrite the Step 1 shell snippet so the trailing-backslash + comment paste-trap is gone; add a callout for the newtesting.LogLine.Prefixfield.configuration.md/llms.txt: reframe thePrefixinline comment so it no longer claims the core prepends.Style:
llms.txtandllms-full.txt(~50 occurrences) per the project's no-em-dashes-anywhere rule.llms-full.txt: typorolled-our-own→roll-our-own; reframe theTesting Transport (lltest)andCapture entries with lltestheadings sincelltestis an alias convention, not the package name.transports/centralleft undocumented intentionally: its package GoDoc is already correct for v2, and the module is not inmonorel.tomlor the v2.0.0 release.Test plan
🤖 Generated with Claude Code