docs: fix four inaccuracies surfaced by post-v2.1.0 audit#83
Merged
Conversation
A doc-audit pass after the v2.1.0 release found four issues, all "Important" (no Critical). All fixed in this commit. 1. whats-new.md: the v2.0.0 / May 2 section incorrectly listed loglayer.Multiline, the JoinPrefixAndMessages prefix-on-non-string fix, transports/cli's TableColumnOrder knob, and transports/http's v2.1.0 features (Headers redaction, ShutdownTimeout, redirect case fix). All shipped on May 3 in v2.1.0 and follow-on sub-module releases. Split into a new May 3 section above May 2. 2. transports/creating-transports.md:190: the JoinPrefixAndMessages description claimed the helper "returns Messages unchanged when Messages[0] isn't a string." Stale since v2.1.0; the helper now handles three cases: string (prepend prefix), *MultilineMessage (prepend to first authored line, rebuild wrapper), and any other value (prepend prefix to %v output). Updated to match. 3. llms.txt and llms-full.txt: the new /log-sanitization page (added in v2.1.0) wasn't listed. Added a one-liner to llms.txt's index and a substantive description to llms-full.txt next to the Multi-line Messages section. 4. llms-full.txt's existing Multi-line entry said "v1 is messages-only" which is the same misleading "v1" framing that was cleaned up earlier in the page itself. Replaced with "honored only as a positional message argument." `bun run docs:build` passes. 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.
A doc-audit pass after the v2.1.0 release found four "Important" inaccuracies (no Critical). All fixed in one commit.
Findings + fixes
whats-new.mdhad v2.1.0 content under v2.0.0 / May 2. Multiline, theJoinPrefixAndMessagesprefix-on-non-string fix,transports/cli'sTableColumnOrderknob, andtransports/http v2.1.0's features (Headers redaction, ShutdownTimeout, redirect case fix) all shipped on May 3 in v2.1.0 and follow-on sub-module releases. Split into a new May 3 section above May 2 with the right per-package version labels.docs/src/transports/creating-transports.md:190describedtransport.JoinPrefixAndMessageswith its pre-v2.1.0 behavior ("returnsMessagesunchanged whenMessages[0]isn't a string"). The helper now handles three cases:string,*loglayer.MultilineMessage, and any other value via%v. Updated to match.llms.txtandllms-full.txtdidn't list the new/log-sanitizationpage. Added a one-liner tollms.txt's index and a substantive description tollms-full.txtnext to the Multi-line Messages section.Bonus:
llms-full.txt's existing Multi-line entry said "v1 is messages-only" — same misleading "v1" framing that was cleaned up inmultiline.mditself earlier. Replaced with "honored only as a positional message argument."Verification
cd docs && bun run docs:buildclean🤖 Generated with Claude Code