Repository navigation
Install API examples from package registries - #196
Merged
Merged
Conversation
why: The Ruby API examples told readers to clone libtmux-ruby and point the Gemfile at the checkout, although every gem is published on RubyGems. They also pinned Ruby 4.0.7, the CI patch release, where the gems support Ruby 3.3 or newer, and wrote /bin/cat and /bin/sh as plain prose. what: - Write the Gemfile against RubyGems at the version the documented revision declares, taken from the exporter's package list; refuse a gem without a release version - Drop the clone step and the vendored bundle path; install and run with bundle install and bundle exec - State Ruby 3.3 or newer and tmux 3.3a or newer as floors, and code-format the paths, file names and Server.start - Regenerate ruby.json at its committed revision, so only the example blocks change
why: The Go API examples cloned libtmux-go and pointed go.mod at the checkout with a replace directive, although the module is published through the Go module proxy. Every example passes against the newest proxy version without the clone. what: - Create the reader's module with go mod init and add the library with go get at @latest, which resolves the newest published version - Drop the hand-written go.mod and GOWORK=off from the run command - State the go directive as a floor (Go 1.26 or newer) and code-format the commands and file names in the prose - Regenerate go.json at its committed revision, so only the example blocks change
why: libtmux-cxx has no registry package, so its examples rightly build from the repository, but they did not say why and pinned Clang 18 with libc++ 18 where CI's Clang 18 is a floor. what: - Say the library is not published to a package registry yet, so the example builds it from its repository - State Clang 18 or newer with libc++ as a floor and code-format the saved file names - Replace only the example blocks in cxx.json; Doxygen 1.14's other output differences stay out of this change
why: The Rust API examples cloned libtmux-rs, copied its consumer manifest with a path dependency on the checkout, and pinned the CI toolchain's patch release, although libtmux is published on crates.io. Every example passes against the published crate. what: - Create the consumer in the empty directory with cargo init, which keeps a src/main.rs saved first, and add libtmux at the workspace version the documented revision declares, which moves only in release commits; add the consumer's other dependencies at the requirements its committed Cargo.toml states - Drop the clone, the copy step and the rust-toolchain.toml pin; state the workspace rust-version as the floor (Rust 1.85 or newer) - Code-format the file and method names in the prose - Regenerate rs.json at its committed revision, so only the example blocks change
why: The Lua API examples cloned libtmux-lua and built its scm rockspec, although libtmux is published on LuaRocks, and pinned Lua 5.5.1 and luv 1.52.1-0. Every example passes with the newest published rock and luv. what: - Install luv and libtmux from LuaRocks into the local tree, without versions, so LuaRocks picks the newest release - Drop the clone and the source build; state Lua 5.1 or newer, the rockspec's floor, and say the C compiler and CMake are for luv - Code-format the saved file names - Replace only the example blocks in lua.json; the regenerated exporter output's other differences stay out of this change
why: The Swift API examples cloned libtmux-swift and depended on the checkout by path, and pinned Swift 6.2.4 and Xcode 26's 6.3 toolchain. SwiftPM consumers depend on the repository at a release. Every example passes against the newest release. what: - Rewrite the port's consumer package to depend on the repository at the release LibTmuxVersion.current declares at the documented revision, which the port's release workflow keeps equal to the tag; use exact:, the only requirement SwiftPM resolves for a prerelease, and name the product package by its URL identity - Drop the clone step and --jobs 5; state the package's tools version as the floor (Swift 6.2 or newer) and code-format names in the prose - Rebuild only the example blocks in swift.json on its committed model, after the previous generator reproduced the file exactly
why: The Java, Kotlin and Scala API examples cloned libtmux-java and built against the checkout through a Gradle composite build at its -SNAPSHOT version, although every module is published on Maven Central. They also stated tmux 3.3a through 3.7c. Every example passes against the newest release with an installed Gradle. what: - Show the port's consumer setup without includeBuild, depending on the newest v* release tag the documented revision contains; neither gradle.properties value is kept equal to it (the API baseline is bumped by hand after a release) - gen-api-model.mjs finds that tag with git describe; refuse a revision with no release tag, or a setup whose dependency is not the development version - Drop the clone and the checkout's gradlew; build with Gradle 9 or newer, and state tmux 3.3a or newer - Drop the source citation from the two rewritten setup files, and code-format paths and file names in the prose - Rebuild only the example blocks in java.json, kotlin.json and scala.json on their committed models, after the previous generator reproduced each file exactly
why: The C# and F# API examples cloned libtmux-dotnet, packed the library from source into a local feed and pinned SDK 10.0.302 through global.json, although both packages are published on NuGet and the consumer projects already reference an exact release. Every example passes on both frameworks against NuGet with the newest SDK. what: - Show only the port's consumer project, which references the release the documented revision declares, and restore it from nuget.org; refuse a project without one exact package reference - Drop the clone, global.json, NuGet.config and the source pack; build and run both frameworks with dotnet build - State the SDK's major version as a floor (the .NET 10 SDK or newer) and code-format names in the prose - Rebuild only the example blocks in csharp.json and fsharp.json on their committed models, after the previous generators reproduced each file exactly
why: The site tests bind every displayed example block and recipe to a receipt from native runs. The registry installs changed the setup blocks, recipes and block positions of every published port, so the receipt and the per-port tests no longer described the pages. what: - Rebind 230 entries (every port but C++, whose code blocks did not change). Each entry finds its program block by its unchanged hash and source URL, takes the setup blocks around it from the port's new layout, and records their hashes, console indices, recipe and per-command expected output. A rewritten setup file (JVM settings and build, Swift Package.swift) loses its sourceFile, since it cites no source - Record each port's runtime, tmux 3.3a and 3.7c, and the scope of the native runs, including the package versions they resolved - Update the Go, Ruby, Rust, Swift, JVM, C# and F# site tests to the new layouts. They assert the registry setup (the RubyGems Gemfile, the exact: dependency, no includeBuild or SNAPSHOT, the cargo init and dotnet build recipes) Checked with scripts/check-example-prose.py --example api, one run per program on each of tmux 3.3a and 3.7c, at each data file's committed revision: 92 programs, 184 runs, all passed (Go 9, Ruby 8, Lua 7, Rust 7, Swift 9, Java 8, Kotlin 8, Scala 16, C# 7, F# 13). Logs and result.json files are kept outside the repository.
tony
force-pushed
the
examples-install-registry
branch
from
October 25, 2026 17:38
58d5b00 to
086e1a0
Compare
tony
temporarily deployed
to
docs-preview-cleanup
October 25, 2026 23:53 — with
GitHub Actions
Inactive
This was referenced Oct 27, 2026
tony
added a commit
to libtmux/libtmux-ruby
that referenced
this pull request
Oct 28, 2026
why: The site still presented libtmux as an alpha: badges, notices, install commands and examples 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. 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) - Open the preview card of a glossary link only after the pointer rests on it for a second, and let Escape cancel a card that has not opened (`link-preview-browser.ts`; libtmux/docs#211) - Let Tab move from the footer's inventory help link to the link in its tooltip at once (`SiteFooter.astro`; libtmux/docs#211) - Set the title of an index-style reference page, such as API reference, in the sans face (`ApiReference.astro`; libtmux/docs#211) - Install each Ruby example's gem from RubyGems at the release version its source revision declares, instead of building from a clone of the repository with a path dependency (`ruby-examples.ts`; libtmux/docs#196) - Install the Ruby gems without an alpha pin: the gem and Bundler lines of libtmux, libtmux-async, libtmux-mcp and libtmux-workspace, and the setup commands of the MCP server (`ports.ts`, `install-matrix.ts`; libtmux/docs#200) - Set the section titles of the MCP reference in the sans face, and keep its sidebar guide line under the parent label and not through the row's own text (`ProtocolReference.astro`, `api-tree.css`; libtmux/docs#211) Shared source: libtmux/docs From: 00045828e6457d142d58933f603665a2ead35811 To: e1ab401f7d6fca5ac9c418bc6c77ca382320cd2e
tony
added a commit
to libtmux/libtmux-lua
that referenced
this pull request
Oct 28, 2026
why: The site still presented libtmux as an alpha: badges, notices, install commands and examples 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. 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) - Open the preview card of a glossary link only after the pointer rests on it for a second, and let Escape cancel a card that has not opened (`link-preview-browser.ts`; libtmux/docs#211) - Let Tab move from the footer's inventory help link to the link in its tooltip at once (`SiteFooter.astro`; libtmux/docs#211) - Set the title of an index-style reference page, such as API reference, in the sans face (`ApiReference.astro`; libtmux/docs#211) - 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) Shared source: libtmux/docs From: 00045828e6457d142d58933f603665a2ead35811 To: e1ab401f7d6fca5ac9c418bc6c77ca382320cd2e
tony
added a commit
to libtmux/libtmux-rs
that referenced
this pull request
Oct 28, 2026
why: The site still presented libtmux as an alpha: badges, notices, install commands and examples 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. 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) - Open the preview card of a glossary link only after the pointer rests on it for a second, and let Escape cancel a card that has not opened (`link-preview-browser.ts`; libtmux/docs#211) - Let Tab move from the footer's inventory help link to the link in its tooltip at once (`SiteFooter.astro`; libtmux/docs#211) - Set the title of an index-style reference page, such as API reference, in the sans face (`ApiReference.astro`; libtmux/docs#211) - Show the typed fields of a Rust struct or payload variant in a Name, Type and Description table, beside the member list when the struct has methods (`api-sections.ts`, `ApiScalarMembers.astro`, `ApiReference.astro`; libtmux/docs#197) - Add the crates of each Rust example with `cargo add` from crates.io at the workspace version the revision declares, instead of building from a clone, and state the minimum Rust version in place of a pinned toolchain file (`rust-examples.ts`; libtmux/docs#196) - Install the Rust workspace CLI and MCP server with `cargo install` and no alpha version, and say on the workspace internals page that releases are numbered 0.1.N and any release may change the API (`ports.ts`, `install-matrix.ts`, `index.md`; libtmux/docs#200) - Show a Rust type alias on its reference page as a declaration line, type Name = Value (`api-sections.ts`; libtmux/docs#205) - Install the Rust MCP server with `tmux-mcp@0.1.0`, and depend on libtmux and tmux-mcp 0.1.0 in the MCP inspect-sessions example in place of git revisions (`connect-client.md`, `inspect-sessions.md`; libtmux/docs#212) - Set the section titles of the MCP reference in the sans face, and keep its sidebar guide line under the parent label and not through the row's own text (`ProtocolReference.astro`, `api-tree.css`; libtmux/docs#211) Shared source: libtmux/docs From: 00045828e6457d142d58933f603665a2ead35811 To: e1ab401f7d6fca5ac9c418bc6c77ca382320cd2e
tony
added a commit
to libtmux/libtmux-go
that referenced
this pull request
Oct 28, 2026
why: The site still presented libtmux as an alpha: badges, notices, install commands and examples 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. 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) - Open the preview card of a glossary link only after the pointer rests on it for a second, and let Escape cancel a card that has not opened (`link-preview-browser.ts`; libtmux/docs#211) - Let Tab move from the footer's inventory help link to the link in its tooltip at once (`SiteFooter.astro`; libtmux/docs#211) - Set the title of an index-style reference page, such as API reference, in the sans face (`ApiReference.astro`; libtmux/docs#211) - Add the module of each Go example with `go get` from the Go proxy, instead of building from a clone of the repository with a `replace` directive (`go-examples.ts`; libtmux/docs#196), and keep the retired step anchors of the attach-and-send-keys example resolving as inventory headings (`attach-and-send-keys.md`; libtmux/docs#166) - Install libtmux-mcp at `v0.1.0` and require libtmux-go v0.1.0 in the Go MCP examples (`connect-client.md`, `inspect-sessions.md`, `run-command.md`; libtmux/docs#212) - Resolve libtmux-go and its workspace module v0.1.0 from the Go proxy in the workspace internals example, with no source checkout and no replace lines (`examples.md`; libtmux/docs#212) - Set the section titles of the MCP reference in the sans face, and keep its sidebar guide line under the parent label and not through the row's own text (`ProtocolReference.astro`, `api-tree.css`; libtmux/docs#211) Shared source: libtmux/docs From: 00045828e6457d142d58933f603665a2ead35811 To: e1ab401f7d6fca5ac9c418bc6c77ca382320cd2e
tony
added a commit
to libtmux/libtmux-java
that referenced
this pull request
Oct 28, 2026
why: The site still presented libtmux as an alpha: badges, notices, install commands and examples 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. 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) - Open the preview card of a glossary link only after the pointer rests on it for a second, and let Escape cancel a card that has not opened (`link-preview-browser.ts`; libtmux/docs#211) - Let Tab move from the footer's inventory help link to the link in its tooltip at once (`SiteFooter.astro`; libtmux/docs#211) - Set the title of an index-style reference page, such as API reference, in the sans face (`ApiReference.astro`; libtmux/docs#211) - Depend the Java, Kotlin and Scala examples on the Maven Central release named by the newest release tag in the documented revision, instead of building from a checkout, and leave the source build out of `settings.gradle.kts` (`jvm-examples.ts`; libtmux/docs#196) - Name the 0.1.0 BOM in the Gradle and Maven setup of the Java library (`ports.ts`; libtmux/docs#200) - Depend the Java MCP and workspace examples, the Java BOM guide, and the Kotlin and Scala concept, capture and attach pages on 0.1.0 from Maven Central, keeping the release checkout only as the Gradle wrapper source (`examples.md`, `queries.md`; libtmux/docs#212) - Say on the Kotlin and Scala transports pages that managed control needs tmux 3.7 or newer (`transports.md`; libtmux/docs#212) - Set the section titles of the MCP reference in the sans face, and keep its sidebar guide line under the parent label and not through the row's own text (`ProtocolReference.astro`, `api-tree.css`; libtmux/docs#211) Shared source: libtmux/docs From: 00045828e6457d142d58933f603665a2ead35811 To: e1ab401f7d6fca5ac9c418bc6c77ca382320cd2e
tony
added a commit
to libtmux/libtmux-dotnet
that referenced
this pull request
Oct 28, 2026
why: The site still presented libtmux as an alpha: badges, notices, install commands and examples 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. 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) - Open the preview card of a glossary link only after the pointer rests on it for a second, and let Escape cancel a card that has not opened (`link-preview-browser.ts`; libtmux/docs#211) - Let Tab move from the footer's inventory help link to the link in its tooltip at once (`SiteFooter.astro`; libtmux/docs#211) - Set the title of an index-style reference page, such as API reference, in the sans face (`ApiReference.astro`; libtmux/docs#211) - Restore `LibTmux` for the C# and F# examples from NuGet at the exact release their project file names, instead of building from a local package feed and a source build (`csharp-examples.ts`, `fsharp-examples.ts`; libtmux/docs#196) - Install the C# package with `dotnet package add` and the workspace and MCP tools with `dotnet tool install` and `dnx`, none with `--prerelease`, and say on the C# workspace internals page that public contracts can change between 0.1.N releases (`ports.ts`, `install-matrix.ts`, `index.md`; libtmux/docs#200) - Record the tmux commands that the C# methods send at LibTmux 0.1.0, with their source lines (`csharp.json`; libtmux/docs#204) - Install LibTmux.Mcp 0.1.0 on the C# MCP pages, and state on run-command that it needs tmux 3.4 or newer (`connect-client.md`, `run-command.md`; libtmux/docs#212) - Set the section titles of the MCP reference in the sans face, and keep its sidebar guide line under the parent label and not through the row's own text (`ProtocolReference.astro`, `api-tree.css`; libtmux/docs#211) Shared source: libtmux/docs From: 00045828e6457d142d58933f603665a2ead35811 To: e1ab401f7d6fca5ac9c418bc6c77ca382320cd2e
tony
added a commit
to libtmux/libtmux-cxx
that referenced
this pull request
Oct 28, 2026
why: The site still presented libtmux as an alpha: badges, notices, install commands and examples 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. 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) - Open the preview card of a glossary link only after the pointer rests on it for a second, and let Escape cancel a card that has not opened (`link-preview-browser.ts`; libtmux/docs#211) - Let Tab move from the footer's inventory help link to the link in its tooltip at once (`SiteFooter.astro`; libtmux/docs#211) - Set the title of an index-style reference page, such as API reference, in the sans face (`ApiReference.astro`; libtmux/docs#211) - Say in the C++ examples that libtmux-cxx is not on a package registry yet, so the page builds it from its repository (`cxx-examples.ts`; libtmux/docs#196) - Set the section titles of the MCP reference in the sans face, and keep its sidebar guide line under the parent label and not through the row's own text (`ProtocolReference.astro`, `api-tree.css`; libtmux/docs#211) Shared source: libtmux/docs From: 00045828e6457d142d58933f603665a2ead35811 To: e1ab401f7d6fca5ac9c418bc6c77ca382320cd2e
tony
added a commit
to libtmux/libtmux-swift
that referenced
this pull request
Oct 28, 2026
why: The site still presented libtmux as an alpha: badges, notices, install commands and examples 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. 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) - Open the preview card of a glossary link only after the pointer rests on it for a second, and let Escape cancel a card that has not opened (`link-preview-browser.ts`; libtmux/docs#211) - Let Tab move from the footer's inventory help link to the link in its tooltip at once (`SiteFooter.astro`; libtmux/docs#211) - Set the title of an index-style reference page, such as API reference, in the sans face (`ApiReference.astro`; libtmux/docs#211) - Depend on the released Swift package in the example's `Package.swift`, instead of a path to a checkout: `from:` the release when the documented revision declares a final release, and `exact:` for a prerelease (`swift-examples.ts`; libtmux/docs#196, libtmux/docs#200) - Recommend `from: "0.1.0"` in the Swift install snippet, in place of an exact pin (`ports.ts`; libtmux/docs#200) - Set the section titles of the MCP reference in the sans face, and keep its sidebar guide line under the parent label and not through the row's own text (`ProtocolReference.astro`, `api-tree.css`; libtmux/docs#211) Shared source: libtmux/docs From: 00045828e6457d142d58933f603665a2ead35811 To: e1ab401f7d6fca5ac9c418bc6c77ca382320cd2e
This branch was previously 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.
The complete API examples on reference pages told readers to
git cloneeach port at a commit and build against the checkout, even where the package is published. They also pinned patch releases such as Ruby 4.0.7, Swift 6.2.4, .NET SDK 10.0.302 and "tmux 3.3a through 3.7c". This branch switches every published port to its registry and states runtimes and tmux as floors.Gemfilenaming the RubyGems releasego mod init+go get …@latestcargo init+cargo addfrom crates.ioluarocks install luv+luarocks install libtmuxPackage.swiftwith.package(url:, exact: <release>)includeBuild, Maven Central release, installed Gradlenet8.0andnet10.0Where each page's version comes from. Each page names the release the documented revision itself declares, never a hand-typed version:
packages[].version.[workspace.package] version.LibTmuxVersion.current, which the port's release workflow keeps equal to the tag.PackageReference.Each of these moves only in the ports' "Tag" release commits. JVM has no such value:
libtmuxApiBaselineis bumped by hand after a release and laggedv0.0.1-alpha.17. Sogen-api-model.mjspasses the newestv*tag the revision contains (port-docs.ymlchecks ports out withfetch-depth: 0). Go and Lua let the resolver pick the newest release. A revision without a release version is refused, with a negative test per port.Data. Each
site/src/data/api/<port>.jsonchanges only in its example blocks. Ruby, Go and Rust were regenerated at their committed revisions. C++ and Lua took only the example blocks from a regeneration, because the newer Doxygen and LuaLS output differs elsewhere. Swift, JVM and .NET blocks were rebuilt on the committed model after the previous generator reproduced each file byte for byte.Receipt.
site/test/fixtures/api-examples.jsonbinds every displayed block and recipe to native runs, so it is rebound here. The 230 entries for every port except C++ (whose code blocks did not change) are relocated by their unchanged program hash, and setup files rewritten for a release lose theirsourceFile. The new recipes then ran throughscripts/check-example-prose.py --example api: 92 programs at each data file's committed revision, on tmux 3.3a and 3.7c, 184 runs, all passed. Each entry records the toolchain and the package versions those runs resolved. For example, Rust'slibtmux@0.1.0-alpha.15resolves to 0.1.0-alpha.17, as caret requirements allow. The Rust recipe usescargo initin the empty directory, which keeps asrc/main.rssaved first;cargo newpluscdwould have left the displayed program outside the project.Port defects found while verifying (not fixed here):
examples/api/workspace_apply.rbloads../workspace.yaml, which no page step supplies, so the live page's example cannot run as written.scripts/export-docsrock_metadata()takes the first non-scm rockspec in ascending order, the oldest release. It also sortsalpha10beforealpha2.What changed, and why: example install steps now match how each package is published, without clone steps or patch pins (
packages/api-model/src/languages/*-examples.ts, their tests,scripts/gen-api-model.mjsfor the JVM tag, regenerated example blocks).Checks run:
@libtmux/api-modelvitest, 1,183 passed; site vitest, 198 files and 6,308 tests passed; oxlint finds nothing in the changed files;tscreports the same 14 pre-existing test-file errors asorigin/main. Every example program above was also run against its published package locally, and its output compared with the expected output on the page. An independent reviewer read the generators and version sources, and its two findings are fixed.Tool use: Claude Code wrote the changes, ran the registry checks and opened this pull request; the maintainer reviews it before merge.