docs: sync README, CHANGELOG, and website with shipped CLI and TUI features - #319
Merged
Conversation
…atures A doc-check before the next release found the README, CHANGELOG, and the Astro website had drifted badly from the code that shipped since v0.13.0 (the entire CLI command surface and several TUI features merged after the v0.13.0 tag but were never documented). README: - Fix the Key Bindings table: `b` (not `g`) opens a linked PR/issue/commit; `g`/`Home` is jump-to-top. Add a Session Actions group covering i, b, O, F, D, T, V, X, m, C, y, x, and : which were missing from the reference. - Add the git status overlay (`i`) to the Features list. - Add `dispatch info` and `dispatch man` command sections. CHANGELOG: - Rewrite the [Unreleased] section to cover the ~40 features that shipped since v0.13.0: the full CLI (open, new, stats, search, export, config, tags, tag, notes, views, aliases, compare, info, watch, prune, man, completion, doctor --json), the git status overlay, open-in-browser, frecency sort, session tags/aliases, DISPATCH_CONFIG, and more. The website changelog page renders from this file. Website: - keys.astro: add the ~20 missing keybindings and a Session Actions group. - cli.astro: expand the command list from 3 to 21 and add DISPATCH_CONFIG. - features.astro: add a Git Status Overlay section with a screenshot. - Add a git-status screenshot scene to the generator and render it for all five themes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 524cf702-8922-4cfd-b23f-4069b734e09b
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.
Summary
A
doc-checkbefore the next release found that the README, CHANGELOG, and the Astro website had drifted badly from the code. The entire CLI command surface and several TUI features merged after the v0.13.0 tag (dated 2026-06-30) but were never documented. This PR brings all three back in sync with the shipped code.Why
The v0.13.0 tag predates ~40 user-facing features that landed between 2026-07-02 and 2026-07-17. If we cut a release now, the notes and docs would describe a fraction of what shipped. Verified findings:
[Unreleased]listed 5 items; the whole CLI (open, new, stats, search, export, config, tags, tag, notes, views, aliases, compare, info, watch, prune, man, completion) plus the git status overlay were absent.gfor "open linked PR/issue/commit" but that action is bound tob;gis jump-to-top. The table was also missing i, b, D, T, F, V, X, m, C, y, x, and the command palette.i) appeared nowhere in the README.dispatch infoanddispatch manhad no README section.keys.astrowas missing ~20 keybindings;cli.astrodocumented 3 of 21 commands.Changes
README:
bopens the linked ref, notg) and add a Session Actions group covering the missing keys.dispatch infoanddispatch mansections.CHANGELOG:
[Unreleased]to cover the ~40 features shipped since v0.13.0. The website changelog page renders from this file, so it updates too.Website:
keys.astro: add the missing keybindings and a Session Actions group.cli.astro: expand the command list from 3 to 21 and addDISPATCH_CONFIG.features.astro: add a Git Status Overlay section with a screenshot.git-statusscreenshot scene to the generator and render it for all five themes.Verification
go build ./...,go vet ./...: passgo build -tags screenshots ./cmd/screenshots/: passgofmt/gofumpt: cleannpm run build(astro): all 7 pages built, including the new git-status screenshot referencegit-status.pngfiles are added; no existing screenshots were re-rendered.