Skip to content

feat(docs): Add Ruby and Lua documentation support - #18

Merged
tony merged 5 commits into
mainfrom
ruby-lua
Sep 21, 2026
Merged

tony merged 5 commits into
mainfrom
ruby-lua

Conversation

@tony

@tony tony commented Sep 21, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Integrate Ruby and Lua metadata, native API models, installation guidance, product documentation, and source-bound guide staging into the owned Astro shell.
  • Give readers canonical core, Async, and runtime documentation areas while retaining legacy source-guide URLs.
  • Keep Lua MCP and Workspace Manager as explicit unavailable status surfaces.
  • Classify exported Lua APIs by public scope and lead major tmux object domains with their primary types.

Verification

  • pnpm test:medium
  • node scripts/check-nav.mjs
  • Complete assembly: 17,810 pages; 2,974,667 links; zero broken targets.
  • Rendered output: 42 checks.
  • Browser matrix: 456/456 checks across desktop, tablet, and phone in both themes.

Boundaries

  • The temporary ruby-lua deployment trigger and temporary shell ownership were removed before this PR.
  • Port-owned caller workflows, environment provisioning, shared-search publication, and post-publication production verification remain separate tracked gates.
  • No port repository was pushed or published.

why: Ruby and Lua need revision-bound documentation that uses the owned
Astro shell, shared API model, and existing publication boundaries.

what:
- Register both ecosystems, versions, installs, quickstarts, and APIs.
- Add source guides, Ruby product docs, and Lua availability pages.
- Bind assembly and publication to exact sources and owned prefixes.
- Cover navigation, search, exports, version policy, and browser checks.
why: Source-import paths obscured the distinction between a port's core
API, companion/runtime integration, and optional products. Public Lua
types in implementation directories also appeared as Internal.

what:
- add one catalog for canonical guides, navigation, cards, redirects,
  and documentation exports
- retain Lua MCP and Workspace as unavailable status surfaces
- place exported Lua types by public scope and lead object domains with
  Server, Session, Window, Pane, and Client
- cover canonical routes, rendered output, and browser behavior
The site test and pull-request preview runners had neither source-owned Ruby and Lua guides nor the exact port revisions their models describe. Stage those guides from model-pinned checkouts before the backlink and assembly audits, and render latest port paths beneath the isolated pr-N preview prefix.\n\nA raw guide checkout is not a native exporter artifact. Keep that exclusion check-only and explicit so each port's docs-site workflow remains responsible for native exporter freshness. Refresh Java's registry entry and use happy-dom's element type so TypeScript 6 can complete the product-docs audit.
@tony
tony merged commit 9de40ca into main Sep 21, 2026
8 checks passed
@tony
tony temporarily deployed to docs-preview-cleanup September 21, 2026 02:57 — with GitHub Actions Inactive
tony added a commit to libtmux/libtmux-java that referenced this pull request Sep 27, 2026
why: libtmux.org's Java pages lacked the Ruby and Lua entries every
other port's pages show, because this repository built them with
libtmux/docs's assembly pinned to a commit from before Ruby and Lua
joined the site (libtmux/docs#18).

what:
- Pin the docs checkout and the reusable deploy workflow to the current
  libtmux/docs commit, together, as the workflow requires
tony added a commit that referenced this pull request Nov 18, 2026
…ns capability directories

why: The OCaml reference pages for Libtmux.Session, Libtmux.Window,
Libtmux.Pane and Libtmux.Operations cannot show the "What is on here"
capability directory until the model carries the prose it is built from, and
the Libtmux_unix.Client directory showed five rows because one of its lists
ended its table early. libtmux-ocaml#18 adds the four directories and words
that list as references alone, and the committed model, guide cache and
manifest still described ffab5fe, the last revision the generators read before
master added three showcases and moved the exporter. Both are handled now, so
the pin moves to master.

what:
- Pin OCaml to libtmux/libtmux-ocaml@1611f141a and regenerate its model and
  path data (exported with OCaml 5.5.2 and odoc-parser 3.2.2, the toolchain
  recorded in the previous model; the exporter now lives at
  scripts/export_api/export_api.py and its digest moves), tmux usage, source
  cache, guide cache, example sources and manifest packages with the
  repository's generators; the mention index and the sidebar sidecar come
  out unchanged
- Adopt the source change between the pins: the model keeps 1141 symbols with
  none added or removed. The four modules gain the directory, the Client
  directory returns to eight rows, and ten operations carry the new options,
  panes and clients programs besides the fifteen that already carried a
  program, whose source link now names the new revision
- Keep every reviewed tmux usage claim: all of them hold at the new revision,
  so only the usage file's revision binding moves
- Take the three changed guides into the guide cache: the showcases, testing
  and benchmarking guides
- List the three new programs, showcase_options.ml, showcase_panes.ml and
  showcase_clients.ml, in the examples index, link all 26 at the new revision
  and expect 26 in the index test
- Name the workflow step "Execute the standalone showcase programs" in the
  seven capability panels: ocaml.yml split the step that ran the installed
  documentation and the showcases in two, and the panel's command
  `opam exec -- python3 test/showcase_test.py "$TMUX_BINARY"` is the second
- Expect the directories of Session (5 rows, 13 references), Window (6, 15),
  Pane (7, 21) and Operations (7, 49), and eight rows, not five, in that of
  Libtmux_unix.Client
- Leave the landing example, its recording and the home fixture at
  ffab5fecd298: examples/showcase_graph.ml is unchanged between that revision
  and the new pin, and the dune files the home page shows are its own

Source refs: libtmux/libtmux-ocaml master
1611f141a1f69bbfd396b15ff12715ff260543dd (#18), previous pin
ffab5fecd298d9516f181576231f54926630118b.

This branch was previously deployed

2 inactive deployments
docs-preview-cleanup — c3a7621d Deployed Sep 21, 2026 by tony via cleanup #12
docs-preview — c3a7621d Deployed Sep 21, 2026 by tony via publish-preview / publish #195
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant