Skip to content

Render a source-bound port's reference from its own source - #31

Merged
tony merged 1 commit into
mainfrom
source-bound-api-model
Sep 27, 2026
Merged

tony merged 1 commit into
mainfrom
source-bound-api-model

Conversation

@tony

@tony tony commented Sep 27, 2026

Copy link
Copy Markdown
Contributor

Part of #27. A port's own docs build passes LIBTMUX_DOCS_SOURCE_SHA, LIBTMUX_DOCS_SOURCE_REF and its checkout, but only Ruby and Lua regenerated their API model from that checkout. Every other port rendered the model committed in this repository, which describes whatever revision was last refreshed by hand.

  • build-site.sh: in a source-bound build of any other port, regenerate the model and its nav sidecar with gen-api-model.mjs, which re-verifies the SHA and records it as the model's revision.
  • A port whose model needs a build product (C++ Doxygen XML, the Swift symbol graph) fails loudly in this mode rather than rendering stale data.

Verified with a local source-bound build of libtmux-rs master: the regenerated model records the checkout's HEAD (d8a0160) as its revision, and the full en/rs/latest tree renders.

why: A port's own docs build names the exact source it publishes, but
only Ruby and Lua regenerated their API model from it. Every other port
rendered the model committed here, which describes whatever revision was
last refreshed: libtmux-rs published alpha.14 prose over an alpha.12
reference.

what:
- In a source-bound build of any other port, regenerate the model and
  its nav sidecar from the verified checkout before rendering
- A local source-bound rs build records the checkout's HEAD as the
  model revision and renders the full latest tree
@tony
tony merged commit 1fa4ae5 into main Sep 27, 2026
8 checks passed
@tony
tony temporarily deployed to docs-preview-cleanup September 27, 2026 18:08 — with GitHub Actions Inactive
tony added a commit that referenced this pull request Nov 19, 2026
why: The Raku examples guide the site serves still told a reader to run
`raku -I. examples/NAME.raku` from a repository checkout and ended on a
paragraph about the example check and LIBTMUX_TEST_TMUX, a variable only
the repository's tests set. libtmux-raku PR #32 rewrites the guide for a
reader who installed the library, and the committed model, guide cache and
manifest still described cce868d81. The pin is the merge commit of the PR,
which is on master.

what:
- Pin Raku to libtmux/libtmux-raku@d26f34d42 and regenerate its model and
  path data (exported with Rakudo 2026.09, the compiler recorded in the
  previous model; the exporter bytes are unchanged), tmux usage, source
  cache, guide cache and manifest packages with the repository's
  generators; the mention index, the example sources and the sidebar
  sidecar come out unchanged
- Adopt the source change between the pins: lib/ is untouched, so the
  model keeps 1069 symbols with none added or removed and no doc changed.
  Only the recorded digests of examples/batch-recovery.raku and
  examples/session-workflow.raku move, and the path list gains
  scripts/lib/Scripts/Processes.rakumod, the helper the example check now
  uses to fail an example that leaves a process running
- Take the rewritten examples guide into the guide cache: the guide
  installs LibTmux from zef with tmux 3.3a or newer on PATH, runs each
  program as `raku NAME.raku`, and no longer ends on the CI paragraph or
  names LIBTMUX_TEST_TMUX; session-workflow.raku and batch-recovery.raku
  now print `Stopped the tmux server and removed its socket` in place of
  their /proc cleanup check, and the README's batch recovery program
  follows the same change
- Keep every reviewed tmux usage claim: lib/ did not move, so no evidence
  line moved and only the usage file's revision binding changes
- Leave the landing example, its recording and the home fixture at
  9a9838047f15: examples/quickstart.raku is unchanged between that
  revision and the new pin; the two docs-workflow pins between the pins
  (#30, #31) change no documented content

Source refs: libtmux/libtmux-raku master
d26f34d4220941578a83022cc4dcb2288cae2ec8 (#32), previous pin
cce868d81823db54a0d161a94db4d078d09f1861.

This branch was previously deployed

2 inactive deployments
docs-preview-cleanup — 8d21aee5 Deployed Sep 27, 2026 by tony via cleanup #22
docs-preview — 8d21aee5 Deployed Sep 27, 2026 by tony via publish-preview / publish #249
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