Skip to content

Correct docs and the sort label ahead of the next release - #41

Merged
callicles merged 1 commit into
mainfrom
chore/pre-0.5-docs-cleanup
Aug 7, 2026
Merged

Correct docs and the sort label ahead of the next release#41
callicles merged 1 commit into
mainfrom
chore/pre-0.5-docs-cleanup

Conversation

@callicles

Copy link
Copy Markdown
Contributor

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

README.md

  • Nix pin example bumped v0.3.1v0.4.0 (newest existing tag).
  • Ctrl+S sort list says ping instead of time, matching the label change below.

src/app.rsSortMode::label returns "ping" instead of "time", so the footer's sort: … 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:

# error = "white on lightred"  # "<fg> on <bg>" badges the failure marker

AGENTS.md — module map brought up to date: sites.rs is NSID-first with id.server as fallback (#39); added the missing theme.rs, globe.rs, and world_data.rs rows; config.rs owns theme/ecs/view as well as resolvers; app.rs also owns the table column layout (#40's TableLayout).

Verification

cargo fmt --check                         → clean
cargo clippy --all-targets -- -D warnings → clean
cargo test                                → 120 passed; 0 failed

cargo run -- example.com --once smoke-tested. PTY run of the real binary confirms the footer now cycles sort: resolver → location → ping → status → answer, agreeing with the README table and the Ping column header. --help shows the new theme line at the width of the surrounding block.

🤖 Generated with Claude Code

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>
@callicles
callicles merged commit 082624e into main Aug 7, 2026
13 checks passed
@callicles
callicles deleted the chore/pre-0.5-docs-cleanup branch August 7, 2026 20:23
@callicles callicles mentioned this pull request Aug 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant