Repository navigation
ci(docs) Adopt kind badges and the tmux catalog - #788
Merged
Merged
Conversation
what: - Draw every API kind mark on one system of six hue families in navigation trees, member lists, index cards, search results, hover cards and prose links, mark only the first mention of a name in a section, and draw modifiers as outlines - Badge each product in the documentation picker and the solution menu with its release stage, or concept for a companion outside Python, behind a hover card that links to the support page, and head each product in the GitHub and Packages menus with a label - Browse the tmux options, hooks and format variables of each pinned release in a catalog, and link and badge tmux commands, options, hooks and formats wherever guides, the manual, API docs and MCP descriptions name them - Show tmux keys as key caps in the manual and guides, and list the CLI Manual, the tmux catalog and the C source reference in the tmux sidebar - Link workspace commands, configuration keys, and MCP tool, prompt and resource names written in code to their reference rows, resolve Sphinx roles in MCP descriptions, and list MCP arguments in the API parameter style - Document type parameters under their own heading with bounds and defaults, and link them from signatures, bounds and prose - Keep the Members heading and the active group heading in view while a long member list scrolls - Move the pages about the site under /meta/ with redirects from the old addresses, drop the cross-port /mcp/ overview, and point the header MCP chip at the current port's MCP home - Rebuild the native tmux examples as a short concept and numbered steps that lead up to the complete script, each step quoting that script - Title the home page "libtmux: pilot tmux in your language" and move a reference page's qualified name into its Source and package disclosure - List the parameters of a Python function's implementation instead of each overload stub, whether or not a docstring describes them, and leave out an undocumented self or cls receiver - Take the release stage of libtmux, tmuxp and libtmux-mcp from their PyPI Development Status classifiers why: A reference page marked names with a different colour per kind, tmux options, hooks and format variables linked nowhere and tmux keys read as plain code, a long member list lost which group a member belonged to, the menus showed no release stage, and several pages still promised a tmux their ports now refuse. Shared source: libtmux/docs From: 7ffc04bceec2cada8149a32e46926cba9fa9ecd2 To: 4e891632a66a144bd9dd7747168cf9218eb32710
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## docs-site-deploy #788 +/- ##
=================================================
Coverage 52.37% 52.37%
=================================================
Files 26 26
Lines 3729 3729
Branches 747 747
=================================================
Hits 1953 1953
Misses 1472 1472
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
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.
Pin only the shared port builder and publisher to
4e891632a66a144bd9dd7747168cf9218eb32710from7ffc04bceec2cada8149a32e46926cba9fa9ecd2. All other workflow bytes, library contents, triggers, permissions and language/source/version inputs remain unchanged.API kind marks now follow one system of six hue families across trees, member lists, cards, search, hover cards and prose, with later mentions of a name in a section left as plain links. A new tmux catalog documents each option, hook and format variable of the pinned releases; tmux names in guides, the manual, API docs and MCP descriptions link to it, and tmux keys show as key caps. Products in the documentation picker carry a release-stage badge with a hover card, workspace and MCP names written in code link to their reference rows, and reference pages show type parameters and keep the Members and group headings in view while a long member list scrolls. Pages about the site moved under /meta/ with redirects, the cross-port MCP overview page is gone, and the Rust, TypeScript, Go, Ruby, Lua, C++, C#, F# and Swift pages state tmux 3.3a as the floor.
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.