Skip to content

Add complete attach examples and a shell-first guide - #56

Merged
tony merged 1 commit into
mainfrom
docs-attach-examples
Sep 30, 2026
Merged

tony merged 1 commit into
mainfrom
docs-attach-examples

Conversation

@tony

@tony tony commented Sep 30, 2026

Copy link
Copy Markdown
Contributor

The shared attach guide now teaches tmux terminal commands and a complete shell script. The port menu opens a complete program for each of the thirteen languages, including imports, project files, pinned dependency setup and an isolated server launcher. Each program finds the exact work session and leaves the existing server running.

Examples that use testing helpers retain them, with a short note linking the port’s regular Server API. Example comments have a 100-column limit, including indentation.

Verification

  • Executed the exact displayed setup for all thirteen ports on tmux 3.7c. Ran each program against tmux 3.2a and verified that work-extra is rejected on 3.7c. Existing servers survived both success and failure cases; all isolated fixtures were removed.
  • Tested the root commands in real terminal sessions on tmux 3.2a and 3.7c: create, detach, reuse, explicit attach and removal. The complete shell script passed on both versions.
  • Compared all forty displayed files and Copy button results with the native-tested bytes at 1440px and 390px. Checked the shared guide’s prompt-free copied commands, port navigation, Server links, search and Markdown/JSON/LLM exports.
  • The full local outer loop passed in 57 seconds. The focused example suite passed all 73 cases. Existing dangling-reference and linter diagnostics remain visible; the full publication audit runs separately in CI.

The native runner is python3 scripts/check-example-prose.py --example attach --port <port> --output-dir <new-directory>, with that port’s native tools and tmux on PATH. The fixture records exact source revisions, commands and file hashes. Native execution is separate from the routine site test loop.

why: The shared attach guide mixed language snippets without imports or
setup. Readers need complete programs and a shell-first tmux explanation.

what:
- Teach terminal attachment and socket selection with tmux commands
- Add complete existing-server examples for all thirteen language ports
- Include project files, pinned dependencies and isolated launchers
- Preserve native program bytes in HTML, Markdown and Copy buttons
- Link temporary testing helpers to the regular Server API
- Enforce a 100-column limit for example comments
@tony
tony force-pushed the docs-attach-examples branch from 42288a2 to 638db5f Compare September 30, 2026 08:08
@tony
tony deployed to docs-preview September 30, 2026 08:31 — with GitHub Actions Active
@tony
tony merged commit d1fa928 into main Sep 30, 2026
3 checks passed
@tony
tony deployed to docs-preview-cleanup September 30, 2026 21:28 — with GitHub Actions Active

This branch was successfully deployed

2 active deployments
docs-preview-cleanup — 638db5f0 Deployed Sep 30, 2026 by tony via cleanup #50
docs-preview — 638db5f0 Deployed Sep 30, 2026 by tony via publish-preview / publish #353
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