Repository navigation
ci(docs) Tint links by kind, indent the API tree - #799
Merged
Merged
Conversation
why: A cross-reference in a doc comment led with a kind badge, so a page that names many methods read as a row of badges. The sidebar tree indented a row's label but not its mark and drew only the guide of a row's parent, and a linked type in a signature or a parameter row was drawn in the ordinary link color. A code literal could also link to an unrelated member: the argument of a call, a control-mode marker, a word of a kebab-case name. what: - Indent a row of the reference sidebar tree as a whole, mark and label together, draw a guide from every ancestor level, and mark the current row by tint and weight alone (`api-tree.css`) - Draw a cross-reference or a tmux name in a doc comment in the color of its kind with a dotted underline instead of a badge before it; the kind stays in the tooltip and the accessible name, and a linked method or function named by a plain path reads as a call (`ApiDoc.astro`, `api.css`) - Highlight every other link to a name while a reader points at it or focuses it, in the doc comments, the member list, the directory chips and the sidebar tree (`cross-highlight.ts`) - Draw a qualified name with a quiet path and its own name in the color of its kind, show the Declared in row as a code link in that color, and keep the copy button from making its row taller (`ApiQualifiedName.astro`, `ApiReference.astro`) - Fold three or more guidance rows of a doc comment, each followed by the references it covers, into a two-column directory of chips, and draw a pipe table as a table (`api-directory.ts`, `api-prose.ts`) - Keep a code literal from linking to an unrelated member: the bare argument of a call, a control-mode marker and a kebab-case word stay plain, and a path that matches no declaration links its longest prefix that is a type (`link.ts`) - Show the permalink beside an API section heading, and a table row's, only on hover, focus or target for a fine pointer; touch and forced colors always show it (`api-headings.css`, `global.css`) - Join the sticky Members and group bars into one toolbar, align each parameter's label with the first line of its value, and list the pages that discuss a symbol one to a line (`ApiPageContents.astro`, `ApiTmuxSections.astro`, `api.css`) - Draw a parameter's name in the name color and a type it links in the type color, and mute the rest of the type (`api.css`) Shared source: libtmux/docs From: 4648913190eb75e4b592db2ba14e15fdcf24174f To: c6b76c7ef7a5a2cdd0513dcbd28ccb5184b61344
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## docs-site-deploy #799 +/- ##
====================================================
- Coverage 52.45% 52.37% -0.09%
====================================================
Files 26 26
Lines 3729 3729
Branches 747 747
====================================================
- Hits 1956 1953 -3
- Misses 1469 1472 +3
Partials 304 304 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
Pin only the shared port builder and publisher to
c6b76c7ef7a5a2cdd0513dcbd28ccb5184b61344from4648913190eb75e4b592db2ba14e15fdcf24174f. All other workflow bytes, library contents, triggers, permissions and language/source/version inputs remain unchanged.Indent a row of the reference sidebar tree as a whole, mark and label together, draw a guide from every ancestor level, and mark the current row by tint and weight alone (
api-tree.css)Draw a cross-reference or a tmux name in a doc comment in the color of its kind with a dotted underline instead of a badge before it; the kind stays in the tooltip and the accessible name, and a linked method or function named by a plain path reads as a call (
ApiDoc.astro,api.css)Highlight every other link to a name while a reader points at it or focuses it, in the doc comments, the member list, the directory chips and the sidebar tree (
cross-highlight.ts)Draw a qualified name with a quiet path and its own name in the color of its kind, show the Declared in row as a code link in that color, and keep the copy button from making its row taller (
ApiQualifiedName.astro,ApiReference.astro)Fold three or more guidance rows of a doc comment, each followed by the references it covers, into a two-column directory of chips, and draw a pipe table as a table (
api-directory.ts,api-prose.ts)Keep a code literal from linking to an unrelated member: the bare argument of a call, a control-mode marker and a kebab-case word stay plain, and a path that matches no declaration links its longest prefix that is a type (
link.ts)Show the permalink beside an API section heading, and a table row's, only on hover, focus or target for a fine pointer; touch and forced colors always show it (
api-headings.css,global.css)Join the sticky Members and group bars into one toolbar, align each parameter's label with the first line of its value, and list the pages that discuss a symbol one to a line (
ApiPageContents.astro,ApiTmuxSections.astro,api.css)Draw a parameter's name in the name color and a type it links in the type color, and mute the rest of the type (
api.css)A cross-reference in a doc comment led with a kind badge, so a page that names many methods read as a row of badges. The sidebar tree indented a row's label but not its mark and drew only the guide of a row's parent, and a linked type in a signature or a parameter row was drawn in the ordinary link color. A code literal could also link to an unrelated member: the argument of a call, a control-mode marker, a word of a kebab-case name.
The exact required CI and root merge receipts of the shared checkpoint must be verified before this operator runs. This PR does not claim an owner build or publication pass. Root reviews this exact caller diff, actual repository-required checks and reviews before merge; optional native estate checks are not a new universal gate.
Execution route:
exact_source_manual_dispatch_after_root_controlled_pin_merge. Root separately schedules reviewed merges and exact source requests from the actual workflow state. If the current active workflow already publishes the intended source on merge, retain that actual event and do not issue a duplicate request. Future source/native/run identities will be bound to actual events.