Title: Docs: document custom workspace builders · Issue #1063 · tmux-python/tmuxp · GitHub
Open Graph Title: Docs: document custom workspace builders · Issue #1063 · tmux-python/tmuxp
X Title: Docs: document custom workspace builders · Issue #1063 · tmux-python/tmuxp
Description: Summary Add developer documentation for workspace builder classes and custom builder integration. Related: #1049, #1054, #1058. Proposed content Explain how tmuxp loads a workspace config and hands the expanded workspace to a builder. Do...
Open Graph Description: Summary Add developer documentation for workspace builder classes and custom builder integration. Related: #1049, #1054, #1058. Proposed content Explain how tmuxp loads a workspace config and hands...
X Description: Summary Add developer documentation for workspace builder classes and custom builder integration. Related: #1049, #1054, #1058. Proposed content Explain how tmuxp loads a workspace config and hands...
Opengraph URL: https://github.com/tmux-python/tmuxp/issues/1063
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Docs: document custom workspace builders","articleBody":"## Summary\n\nAdd developer documentation for workspace builder classes and custom builder integration.\n\nRelated: #1049, #1054, #1058.\n\n## Proposed content\n\n- Explain how tmuxp loads a workspace config and hands the expanded workspace to a builder.\n- Document the classic builder default and how to select a custom builder by dotted path.\n- Document optional trusted import paths for user config directories, including why tmuxp avoids site-directory startup processing for this feature.\n- Document package entry points once the builder protocol/entry-point stage exists.\n- Show small custom builder examples that use libtmux object APIs, raw tmux commands, and normal Python code.\n- Explain required builder behavior around plugin lifecycle hooks, progress callbacks, script output, append/detached behavior, and session exposure.\n- Include testing guidance and examples for custom builders.\n- Explain when users should choose classic behavior, readiness tuning, or an experimental/parallel builder.\n\n## Acceptance criteria\n\n- Docs include a working minimal custom builder example.\n- Docs include a configuration example using `workspace_builder` and trusted import paths.\n- Docs explain the security/trust boundary for importing custom Python code.\n- Docs cross-reference the builder protocol and pane readiness configuration once those stages land.\n","author":{"url":"https://github.com/tony","@type":"Person","name":"tony"},"datePublished":"2026-06-27T23:36:47Z","url":"https://github.com/tmux-python/tmuxp/issues/1063"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:cd70bacc-3c3c-392e-d879-5b7b34e752dc |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | DDA0:2A0C56:B3D03:F2F1B:6B007F97 |
| html-safe-nonce | 0ff861fd71876289bc1a5eea7159e6fb316396a644a0f2ddf8e30bb7c3d0d4a0 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEREEwOjJBMEM1NjpCM0QwMzpGMkYxQjo2QjAwN0Y5NyIsInZpc2l0b3JfaWQiOiIxMzg0NDc0MTMyNjExMTA0NjYzIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 70763055902669103344bb57b2b9e0efd43e8a2423fa522c3e5d9baad38ce4ad |
| hovercard-subject-tag | issue:4760339514 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/tmux-python/tmuxp/1063/issue_layout |
| twitter:image | https://opengraph.githubassets.com/52057767fbcfd9884a9cb1e6d8d2b787023f38b253c7b245fc31d3b0e1284d24/tmux-python/tmuxp/issues/1063 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/52057767fbcfd9884a9cb1e6d8d2b787023f38b253c7b245fc31d3b0e1284d24/tmux-python/tmuxp/issues/1063 |
| og:image:alt | Summary Add developer documentation for workspace builder classes and custom builder integration. Related: #1049, #1054, #1058. Proposed content Explain how tmuxp loads a workspace config and hands... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | tony |
| hostname | github.com |
| expected-hostname | github.com |
| None | 82c186f13e104004ab7bdb779f3195e59dd38bfde531aaa74b76470fc2462b83 |
| turbo-cache-control | no-preview |
| go-import | github.com/tmux-python/tmuxp git https://github.com/tmux-python/tmuxp.git |
| octolytics-dimension-user_id | 37234308 |
| octolytics-dimension-user_login | tmux-python |
| octolytics-dimension-repository_id | 12398170 |
| octolytics-dimension-repository_nwo | tmux-python/tmuxp |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 12398170 |
| octolytics-dimension-repository_network_root_nwo | tmux-python/tmuxp |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | d1bc2aa1939001689f5ce935982c10a6138f745c |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width