docs: GitHub palette, a real landing page, and three corrections - #39
Closed
lestex wants to merge 3 commits into
Closed
docs: GitHub palette, a real landing page, and three corrections#39lestex wants to merge 3 commits into
lestex wants to merge 3 commits into
Conversation
The site was stock Material in deep purple, and the home page opened with a wall of prose. Both now look like what they document. The colours are GitHub's own Primer tokens rather than approximations, so a screenshot of the docs sits beside a screenshot of the repo without the two reading as different products. Both schemes go through `custom`, which hands Material the CSS variables in docs/stylesheets/torrnado.css. The landing page leads with the wordmark, a two-line tagline, two calls to action and the TUI itself in a terminal frame, then a stat bar, a feature grid and a tabbed install block. Content width is unchanged -- the nav and table of contents stay, so every page still measures the same. Note the light scheme's header tokens: Material paints the header background from --md-primary-fg-color and its text from --md-primary-bg-color. The names read backwards, and getting them the wrong way round gives white text on a white header, which is invisible rather than merely ugly.
Three things the docs asserted that are not true. The TUI page described the list as "one torrent per two lines: the data columns, and a thin progress underline beneath the name", and its layout diagram drew that. Progress became a column -- a bar then its percentage -- and renderRow returns exactly one line per torrent; the comment on progressCell even says it replaced the underline. Diagram and prose both redrawn, and the narrow-pane behaviour said out loud. The command palette section appeared twice on the same page, the same ten-row table verbatim, and the paragraph about quoting appeared twice after it. One of each survives. While there, the table now lists the `:rm`/`:rm!` aliases the palette accepts, and the Files tab's `=`/`_` priority keys, which spare you the shift. The release ritual ended `git push --follow-tags`, which cannot work: main is protected, so the changelog commit goes through a pull request and the tag is cut on the merge commit afterwards. Tagging the local commit instead names one that is not on the branch.
The header claimed docs/CNAME keeps the custom domain across deployments. It does not: the file is deployed and served, but Pages only reads it to configure a domain for branch-based sites, not for build_type: workflow. The API reported cname: null until the domain was set explicitly. Also worth writing down, because it cost an afternoon: until Pages is enabled at all, the build job passes and only deploy fails, with a bare HttpError: Not Found that says nothing about which setting is missing.
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.
Restyles the site and fixes what it got wrong.
Look
Stock Material in deep purple became GitHub's own Primer tokens, so a screenshot of the docs sits beside a screenshot of the repo without the two reading as different products. Both schemes go through
custom, handing Material the variables indocs/stylesheets/torrnado.css.The landing page now leads with the wordmark, a tagline, two calls to action and the TUI in a terminal frame, then a stat bar, a feature grid and a tabbed install block. Content width is unchanged — the nav and table of contents stay, so every page still measures the same.
One trap worth knowing: Material paints the header background from
--md-primary-fg-colorand its text from--md-primary-bg-color. The names read backwards, and I had them inverted in the light scheme — white text on a white header. Caught by actually loading the page in both schemes.Corrections
Found by checking each page against the code rather than reading it:
renderRowreturns one line; progress is a column, andprogressCell's comment says it replaced the underline:remove/:remove!:rm/:rm!; the Files tab also takes=/_so priority needs no shiftgit push --follow-tagsdocs/CNAME"keeps it across deployments"build_type: workflow; the API reportedcname: nulluntil the domain was set explicitlyChecked and found accurate, so untouched: every CLI subcommand and flag against
--help, all TUI keys against the keymap, every config key and section against the struct, and all eight theme names.Verified with
mkdocs build --strictand by loading the site in both light and dark.