Skip to content

Docs: document custom workspace builders #1063

Description

@tony

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.
  • Document the classic builder default and how to select a custom builder by dotted path.
  • Document optional trusted import paths for user config directories, including why tmuxp avoids site-directory startup processing for this feature.
  • Document package entry points once the builder protocol/entry-point stage exists.
  • Show small custom builder examples that use libtmux object APIs, raw tmux commands, and normal Python code.
  • Explain required builder behavior around plugin lifecycle hooks, progress callbacks, script output, append/detached behavior, and session exposure.
  • Include testing guidance and examples for custom builders.
  • Explain when users should choose classic behavior, readiness tuning, or an experimental/parallel builder.

Acceptance criteria

  • Docs include a working minimal custom builder example.
  • Docs include a configuration example using workspace_builder and trusted import paths.
  • Docs explain the security/trust boundary for importing custom Python code.
  • Docs cross-reference the builder protocol and pane readiness configuration once those stages land.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions