Skip to content

Make general guides runnable with tmux shell scripts - #58

Draft
tony wants to merge 1 commit into
mainfrom
docs-shell-guides
Draft

tony wants to merge 1 commit into
mainfrom
docs-shell-guides

Conversation

@tony

@tony tony commented Sep 30, 2026 •

Copy link
Copy Markdown
Contributor

General guides now teach tmux with complete shell scripts for setup, input, capture, queries and tests. Each script owns a private socket, reports failures and cleans up. The port dropdown opens language-specific explanations linked to the complete, verified capture and attach programs.

Add forty owned guide pages for the eight previously shared languages. Keep general shell instructions on the root pages, preserve existing guide anchors, and link Rust and C++ test-fixture guidance to each port's regular Server API. The example runner also executes the displayed shell files and rejects changes to their recorded bytes before running commands.

Validation:

  • All five displayed scripts and setup commands pass on tmux 3.2a and 3.7c, including expected output and removal of private sockets.
  • Ten deliberate failures cover empty and ambiguous queries, assertion failure, input timeout and cleanup failure. Cleanup failures report and retain the socket for recovery.
  • The public runner passes all five guides; a changed file fails before creating an execution directory.
  • Desktop and phone browser checks cover copied script bytes, eight port destinations for each guide, forty owned pages, and the regular Server links.
  • All 88 complete-example tests pass. The final local outer loop passes in 45.6 seconds, including type, navigation and browser checks.
  • Existing unresolved API mentions decrease from 23 to 20; no new unresolved mentions are introduced.

The saved shell examples use ordinary #!/bin/sh files. The capture guide explains that output exceeding the pane height moves into scrollback, which requires capture-pane -p -S - to retrieve. The final English render builds 2,980 pages; the guide audit checks 495 internal links and preserves the five root guides' existing anchors.

why: Shared guides mixed language fragments that depended on missing
imports, setup and state from other examples. Port readers need their
own API semantics and complete programs they can copy and execute.

what:
- Teach five general guides with complete tmux shell programs
- Add owned guide pages for the eight previously shared languages
- Route library examples to verified capture and attach programs
- Link external APIs and regular Server objects used after test fixtures
- Extend the native runner and receipts to cover shell guides
- Preserve guide anchors and enforce the 100-column comment limit

verification: Run all five displayed programs on tmux 3.2a and 3.7c.
Exercise empty and ambiguous matches, assertion failures, input timeout
and cleanup failure. Reject changed example bytes before execution.
Check copied code and port navigation at desktop and phone widths.
The final outer loop passes in 45.6 seconds.
@tony
tony force-pushed the docs-shell-guides branch 2 times, most recently from d46d7ed to 32590c8 Compare September 30, 2026 22:31
@tony
tony marked this pull request as draft September 30, 2026 22:37
@tony
tony deployed to docs-preview September 30, 2026 22:45 — with GitHub Actions Active

This branch was successfully deployed

1 active deployment
docs-preview — 32590c8e Deployed Sep 30, 2026 by tony via publish-preview / publish #358
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