docs: show hideGit in the README, and stop calling shipped work planned - #76
Merged
Conversation
Four screenshots, and a features table that had gone out of date. The table still listed submodules, worktrees, LFS and the PT-BR translation as planned. All four shipped across #61–#75, so the row said the opposite of the truth about a fifth of what the application does. It is now four rows, each naming what actually landed, and the intro says the same thing in prose. The screenshots are the release build opened on this repository — the commits in the graph are the ones in the log — showing the graph with a syntax-highlighted diff, hunk staging, the light theme, and the command palette. `docs/screenshots/README.md` records how to retake them, because two of the three steps are not obvious and one is a privacy question rather than a technical one. hideGit keeps its recent-repository list under `$HOME`, so a screenshot taken from an ordinary session publishes the name and path of every repository the author has open, and those are usually somebody else's to disclose. Pointing `HOME` at an empty directory gives a session that has never opened anything else, and `HIDEGIT_NO_KEYCHAIN=1` does the same for the forge: signed out, so no pull request or account detail can appear. That is also why there is no screenshot of the pull request pane — it needs an account, and one would have to come from a repository whose PRs are already public. The third step is that a window is captured by its id rather than by a screen rectangle, since a rectangle captures whatever happens to be on top of it. A screenshot is documentation that cannot be tested, so the file says plainly that these go stale first and should be retaken in the commit that changes what they show.
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.
Four screenshots, and a features table that had gone out of date.
The table was wrong about a fifth of the application
It still listed submodules, worktrees, LFS and the PT-BR translation as ⬜ planned. All four shipped across #61–#75 — fourteen PRs. The row said the opposite of the truth, which is worse than saying nothing.
It is now four ✅ rows naming what actually landed, and the intro paragraph says the same in prose.
The screenshots
The release build opened on this repository — the commits in the graph are the ones in the log. No mockups.
graph.pngstaging.pnglight-theme.pngcommand-palette.png792 KB for the four.
docs/screenshots/README.md, because one step is a privacy questionTaking these is three steps and only one is obvious.
hideGit keeps its recent-repository list under
$HOME. A screenshot from an ordinary session therefore publishes the name and path of every repository the author has open — and those are usually somebody else's to disclose, not the author's. PointingHOMEat an empty directory gives a session that has never opened anything else;HIDEGIT_NO_KEYCHAIN=1does the same for the forge, so no pull request, review or account detail can appear.That is also why there is no screenshot of the pull request pane: it needs an account. One would have to come from a repository whose PRs are already public, with the same care taken over everything else on screen. Said in the file rather than left as a gap someone fills in carelessly later.
The third step is that a window is captured by its id, not by a screen rectangle — a rectangle captures whatever happens to be on top of it.
The file also says plainly that a screenshot is documentation that cannot be tested, so these go stale first and should be retaken in the commit that changes what they show.
Gate
cargo fmt --all -- --checkclean. No code changed, so clippy and the test suite are unaffected — CI runs them anyway.