Correct the built-in UI size in the README; tidy stale doc comments#98
Merged
Conversation
The README still described the built-in docs page as ~1.6 KB — its size back at v0.1.0. It has grown to ~10 KB since (security headers, the dismissable notice, method badges, expandable operations), so the figure was off by several times and disagreed with rawui.go. Corrected both README spots and aligned the source comment. Also reworded a couple of doc comments that still referenced the old "Tier" terminology the package overview no longer uses. Logged under Unreleased — docs only, no code change.
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.
Docs only — no code change, logged under [Unreleased] (no version bump).
The final pre-announcement sweep caught the README still calling the built-in docs page ~1.6 KB (its size at v0.1.0). It's grown to ~10 KB since (security headers, the dismissable notice, method badges, expandable operations) — I measured the served
/docs/page at 10105 bytes against v0.6.7. It was also off fromrawui.go's own comment.README.md(×2: features bullet + UI table)~1.6 KB→~10 KBrawui.gocomment~6 KB→~10 KB(the served page is the source of truth)cmd/demo/main.go+doc.go: reworded two comments that referenced the old "Tier" vocabulary the package overview dropped; rewrapped one over-longdoc.golineCHANGELOG.md: noted under[Unreleased]CHANGELOG.mdline 607 (the historical v0.1.0 entry) keeps its original~1.6 KB— that was accurate then.Build / vet / gofmt clean; the default-UI CSP parity test still passes (only a comment changed, the served page bytes are unchanged).