feat(site) Add MCP and Workspace Manager docs per port - #3
Open
tony wants to merge 32 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Changes
Documentation and navigation
Readers can enter either product from a port home page and keep the selected product while following guides, API references, or equivalent pages in another language. The docs describe each port's installation, configuration, workspace behavior, tool access, failure handling, and cleanup. Python pages link to the maintained tmuxp and libtmux-mcp documentation.
Package and source-consumer boundaries remain explicit. Workspace convergence, live export, YAML support, and MCP workspace operations are documented according to the selected implementation.
Reference and provenance
The shared API model identifies product ownership, exported declarations, supporting signature types, and package-specific source repositories and revisions. Extraction follows the configured documentation worktrees, including the separate Python projects. Reference rendering also handles Java overload visibility, Swift inherited origins, Go exported values, and standard/dependency type links.
MCP catalogs combine source registrations with paginated runtime discovery. Each tool retains its wire name, schemas, annotations, and reference configuration. Cross-port links exclude known operations that share a name but do different work.
Search and exports
Nested pages load the locale search index and return product API results at scoped URLs. Product pages include breadcrumbs, canonical and robots metadata, and appropriate semantic types. Markdown, JSON, documentation catalogs, and LLM exports include the new sections. Product pages do not advertise translations that have not been authored.
Test plan
pnpm test: source suites, Oxlint, type checks, generated-data checks, and fresh desktop/tablet/phone browser checks pass for the final content.pnpm test:publication: the complete local publication audit passed, including source freshness, assembled output, links, search, reference fidelity, navigation, tables, fonts, visual comparisons, and native documentation style checks.pnpm build:siteandproduct-docs.test.tspass; rendered checks confirm the tmuxp links across all workspace overviews and Rust topics.The full publication audit preceded the final prose-link edit. Some MCP embedding examples received compilation checks rather than execution.
Reference availability follows the selected source snapshots. Python's
TmuxTimeoutand_split_records, and .NET'sTmuxOption.Inherited, were present in the previous generated models but are absent from those documentation worktrees.