Correct docs and the sort label ahead of the next release - #41
Merged
Conversation
A docs audit and QA pass over main (0.4.0 plus #37-#40) turned up a handful of places where the docs and the UI had drifted apart: - CHANGELOG: link issue #35 alongside PR #38 on the TTL-outlier entry, to match how the sibling entries cite their issue. Amend the 80-column entry to cover the Time -> Ping header rename and the matching `--once` column widths and right-aligned TTL, and the error-badge entry to mention that the badge also covers the "not a domain name" label. Drop a stray blank line between two bullets in the released 0.4.0 section. - README: bump the Nix pin example to v0.4.0, the newest tag that exists. - app.rs: `SortMode::label` still said "time" for the latency sort, so the footer disagreed with the column #40 renamed to Ping. Say "ping", and update the README key-binding row to match. No changelog entry of its own: the label ships unreleased, covered by the amended #40 entry. - main.rs: document the `"<fg> on <bg>"` theme form in the long --help, which #40 added but never wrote down. - AGENTS.md: the module map was missing theme.rs, globe.rs and world_data.rs, still described sites.rs as id.server-only (NSID leads since #39) and config.rs as resolvers-only (it owns theme/ecs/view too), and app.rs now owns TableLayout. Verified: cargo fmt --check, clippy -D warnings and 120 tests pass; `--once` prints its table; --help shows the new theme line; and driving the real binary through a PTY shows the footer read "sort: ping" after cycling Ctrl+S twice to the latency mode. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Merged
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.
Pre-release docs and consistency cleanup, from a QA + documentation audit of main ahead of cutting 0.5.0. No behavior changes except one user-visible label.
What changed
CHANGELOG.md
Time→Pingheader rename and that--onceprints the same name/location/IP widths and right-aligns its TTL — both shipped in Fit the table in 80 columns, badge errors, coarsen the countdown #40 but were undocumented, and the--onceformat is documented as script-consumable.not a domain namelabel), not just the status glyph and word.Addedsection (formatting only).README.md
v0.3.1→v0.4.0(newest existing tag).pinginstead oftime, matching the label change below.src/app.rs —
SortMode::labelreturns"ping"instead of"time", so the footer'ssort: …agrees with the column header #40 renamed. Covered by the amended #40 changelog entry per the AGENTS.md amendment rule (behavior introduced in[Unreleased]).src/main.rs — the long
--help's[theme]block documents the"<fg> on <bg>"badge form added in #40:AGENTS.md — module map brought up to date:
sites.rsis NSID-first withid.serveras fallback (#39); added the missingtheme.rs,globe.rs, andworld_data.rsrows;config.rsowns theme/ecs/view as well as resolvers;app.rsalso owns the table column layout (#40'sTableLayout).Verification
cargo run -- example.com --oncesmoke-tested. PTY run of the real binary confirms the footer now cyclessort: resolver → location → ping → status → answer, agreeing with the README table and thePingcolumn header.--helpshows the new theme line at the width of the surrounding block.🤖 Generated with Claude Code