docs(redesign): restructure documentation to Library Skeleton pattern#1
Merged
docs(redesign): restructure documentation to Library Skeleton pattern#1
Conversation
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
tony
force-pushed
the
doc-redesign-spring-2026
branch
4 times, most recently
from
03f13bd to
237359b
Compare
…e URLs why: sphinx-design is needed for grid cards in the documentation landing pages and section indexes. Doc-site URLs added as inline comments for quick reference when managing dependencies. what: - Add sphinx-design to docs and dev dependency groups - Annotate all doc dependencies with their documentation URLs
why: The landing page mixed README include with custom content. Topic
files (architecture, concepts, safety) were scattered at root. No
topics/ or project/ sections. The tools overview missed the "Server
Management" category. A broken {ref} link pointed to a nonexistent
"about" page.
what:
Landing page:
- Compose standalone homepage with hero + pre-alpha warning
- "Get started in one command" block above grid cards for instant
activation (claude mcp add + agent prompt example)
- Two responsive 3-card grid rows:
Quickstart/Tools/Configuration + MCP Clients/Topics/Contributing
- Install snippet (uvx + pip)
Structure:
- Create topics/ — move architecture.md, concepts.md, safety.md,
troubleshooting.md (from guides/) into it with grid cards index
- Create project/ section with grid cards:
contributing.md (moved from development.md), code-style.md, releasing.md
- Add grid cards to topics/, reference/api/, tools/ index pages
- Add "Server Management" card to tools/index.md (was missing)
- Fix broken {ref}`about <about>` → explicit API reference link
Dependencies:
- Add sphinx-design to docs and dev dependency groups
- Add sphinx_design extension and myst_heading_anchors = 4 to conf.py
Redirects:
- architecture.md → topics/architecture.md
- concepts.md → topics/concepts.md
- safety.md → topics/safety.md
- guides/troubleshooting.md → topics/troubleshooting.md
- development.md → project/contributing.md
- Removed stale circular redirect (topics/safety → safety)
tony
force-pushed
the
doc-redesign-spring-2026
branch
from
237359b to
48ea0fe
Compare
tony
force-pushed
the
doc-redesign-spring-2026
branch
from
5300def to
48ea0fe
Compare
tony
added a commit
that referenced
this pull request
Mar 24, 2026
docs(redesign) — Library Skeleton pattern (#1) Restructure libtmux-mcp documentation to the Library Skeleton. topics/ created (architecture, concepts, safety, troubleshooting). project/ section. Get started in one command instant activation above grid cards. Server Management card added to tools/. Broken ref fixed. sphinx-design added.
tony
added a commit
that referenced
this pull request
Mar 25, 2026
Restructure libtmux-mcp documentation to the Library Skeleton. topics/ created (architecture, concepts, safety, troubleshooting). project/ section. Get started in one command instant activation above grid cards. Server Management card added to tools/. Broken ref fixed. sphinx-design added.
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
2 participants
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.
Composed landing page, responsive grid cards, topics/, project/, internals/ sections. See commit for details.