Repository navigation
Conversation
what: - Publish `objects.inv` and `targets.json` at the root of each port version, naming the pages, headings, workspace table rows, MCP schema fields, command options and API declarations the build rendered, and stop the build when an API declaration has no rendered target (`inventory.ts`, `inventory-publisher.ts`, `inventory-targets.ts`, `targets.ts`; libtmux/docs#166) - Link the footer of a port page to the inventory of its port version, to the full inventory and to a guide on linking from Sphinx, and list the same inventory and target files in the `docs.json` manifest (`SiteFooter.astro`, `inventory-links.ts`, `docs.json.ts`; libtmux/docs#166) - Export the rows of the shared workspace command and configuration tables as Sphinx option, setting and environment variable targets, and keep a page's identity across a move through `inventoryId` and `inventoryAliases` in its frontmatter (`rehype-row-anchors.ts`, `load.md`, `panes.md`, `environment.md`, `content.config.ts`; libtmux/docs#166) - Link the AI policy, which the root site publishes at `/meta/ai-policy/`, from the footer (`SiteFooter.astro`, `ai-policy.md`; libtmux/docs#194) - Show a final release on its badge as its series, 0.x for 0.1.0, with the line "Released; the API may change.", and replace the alpha notice with an early-release notice that returns once for a reader who dismissed it (`ports.ts`, `registry.json`, `PrereleaseNotice.astro`; libtmux/docs#200) - Remove the stable docs channel: a release tag publishes at its own version, a prerelease also as `next`, and the newest final release tag is the default and indexed version, or `latest` while the port has none; an older tag pushed later does not take the default (`port-docs-identity.sh`, `publish-plan.mjs`, `gen-versions.mjs`, `versions.ts`; libtmux/docs#201) - Leave a release-numbering label such as 0.1.N plain in prose instead of resolving it as an API name (`resolver.ts`; libtmux/docs#204) - Give a symbol's tmux commands, tmux C declarations, hooks, options and formats, Guides and equivalents in other ports their own sections on its API reference page and in its Markdown export, ahead of Related types (`api-tmux-sections.ts`, `ApiTmuxSections.astro`, `ApiReference.astro`; libtmux/docs#202) - Draw the nested guide line in every sidebar layout, set Grouped's group headings bold as Outline's are, and make the API glossary the last row of the reference sidebar and the last search result (`api-tree.css`, `ApiTree.astro`, `api-tree.ts`; libtmux/docs#208) - Install the `luv` and `libtmux` rocks of each Lua example from LuaRocks, instead of building from a clone of the repository with a rockspec (`lua-examples.ts`; libtmux/docs#196) - Install the Lua rock with `luarocks --local install libtmux` and no alpha version (`ports.ts`; libtmux/docs#200) why: The site still presented libtmux as an alpha: badges, notices and install commands carried alpha pins and prerelease flags, and a docs channel stood for a release state that no libtmux release has. A Sphinx project had no inventory to link to, tmux commands and cross-port links sat in small rows under each declaration, TypeScript aliases showed no declaration, and native Python documentation pages listed every page in one flat sidebar column. Shared source: libtmux/docs From: 00045828e6457d142d58933f603665a2ead35811 To: ab9f3cee9ca6a231ffc2e96f37b40a74010b902b
Contributor
Author
|
Superseded: the publisher at libtmux/docs@ab9f3cee9 fails this repository's docs build for Python's native pages (scripts/inject-shell.mjs: an undeclared --native-class-row-height). The fix ships in the next docs train, and a new pin to that merge replaces this PR. |
This branch was successfully deployed
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
ab9f3cee9ca6a231ffc2e96f37b40a74010b902bfrom00045828e6457d142d58933f603665a2ead35811. All other workflow bytes, library contents, triggers, permissions and language/source/version inputs remain unchanged.Publish
objects.invandtargets.jsonat the root of each port version, naming the pages, headings, workspace table rows, MCP schema fields, command options and API declarations the build rendered, and stop the build when an API declaration has no rendered target (inventory.ts,inventory-publisher.ts,inventory-targets.ts,targets.ts; Publish durable Sphinx inventories and footer links docs#166)Link the footer of a port page to the inventory of its port version, to the full inventory and to a guide on linking from Sphinx, and list the same inventory and target files in the
docs.jsonmanifest (SiteFooter.astro,inventory-links.ts,docs.json.ts; Publish durable Sphinx inventories and footer links docs#166)Export the rows of the shared workspace command and configuration tables as Sphinx option, setting and environment variable targets, and keep a page's identity across a move through
inventoryIdandinventoryAliasesin its frontmatter (rehype-row-anchors.ts,load.md,panes.md,environment.md,content.config.ts; Publish durable Sphinx inventories and footer links docs#166)Link the AI policy, which the root site publishes at
/meta/ai-policy/, from the footer (SiteFooter.astro,ai-policy.md; Publish the AI policy docs#194)Show a final release on its badge as its series, 0.x for 0.1.0, with the line "Released; the API may change.", and replace the alpha notice with an early-release notice that returns once for a reader who dismissed it (
ports.ts,registry.json,PrereleaseNotice.astro; Document the 0.1.0 releases and drop stable from the site docs#200)Remove the stable docs channel: a release tag publishes at its own version, a prerelease also as
next, and the newest final release tag is the default and indexed version, orlatestwhile the port has none; an older tag pushed later does not take the default (port-docs-identity.sh,publish-plan.mjs,gen-versions.mjs,versions.ts; Remove the stable docs channel docs#201)Leave a release-numbering label such as 0.1.N plain in prose instead of resolving it as an API name (
resolver.ts; Navigate PowerShell's .NET dependency at 0.1.0 docs#204)Give a symbol's tmux commands, tmux C declarations, hooks, options and formats, Guides and equivalents in other ports their own sections on its API reference page and in its Markdown export, ahead of Related types (
api-tmux-sections.ts,ApiTmuxSections.astro,ApiReference.astro; Give tmux and cross-port links their own reference sections docs#202)Draw the nested guide line in every sidebar layout, set Grouped's group headings bold as Outline's are, and make the API glossary the last row of the reference sidebar and the last search result (
api-tree.css,ApiTree.astro,api-tree.ts; Draw sidebar guide lines in every layout and put the glossary last docs#208)Install the
luvandlibtmuxrocks of each Lua example from LuaRocks, instead of building from a clone of the repository with a rockspec (lua-examples.ts; Install API examples from package registries docs#196)Install the Lua rock with
luarocks --local install libtmuxand no alpha version (ports.ts; Document the 0.1.0 releases and drop stable from the site docs#200)The site still presented libtmux as an alpha: badges, notices and install commands carried alpha pins and prerelease flags, and a docs channel stood for a release state that no libtmux release has. A Sphinx project had no inventory to link to, tmux commands and cross-port links sat in small rows under each declaration, TypeScript aliases showed no declaration, and native Python documentation pages listed every page in one flat sidebar column.
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:
controlled_real_pin_merge_push. 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.