Commit abcd184
authored
docs(tools): split area pages into per-tool pages by tmux scope (#26)
why: The 7 area pages under `docs/tools/` packed 47 tools into long
documents organized by safety tier (Inspect/Act/Destroy). Every
`{tool}`…`` reference in prose pointed into section anchors on
those pages, and agents navigating the site had to scroll an area
page to find a single tool's shape. Per-tool pages align with the
Server > Session > Window > Pane hierarchy agents already reason
about, give every tool a canonical citable URL, and let the
sidebar scope itself to the area the reader is currently in.
what:
- **47 per-tool pages** organized under six tmux-scope directories:
`docs/tools/{server,session,window,pane,buffer,hook}/`. Each
page carries the existing `{fastmcp-tool}` directive, its "Use
when / Avoid when / Side effects / Example" prose, and the
matching `{fastmcp-tool-input}` directive — extracted verbatim
from the old area pages, no rewrites.
- **Six area `index.md` pages** with `grid-item-card` summaries +
hidden `{toctree}` so the left sidebar populates per area. The
top-level `tools/index.md` keeps its "Which tool do I want?"
decision tree and gains a new scope-grouped toctree.
- **`docs/conf.py` `fastmcp_area_map`** remapped from flat area
basenames (`"pane_tools": "panes"`) to scope-index paths
(`"pane_tools": "pane/index"`). `option_tools` / `env_tools`
now route to `server/`; `wait_for_tools` routes to `pane/`.
- **`sphinxext-rediraffe` redirects.** Seven entries in
`docs/redirects.txt` map every deleted area page to its new
scope index — `tools/panes → tools/pane/index`,
`tools/sessions → tools/server/index`, `tools/windows →
tools/window/index`, `tools/buffers → tools/buffer/index`,
`tools/hooks → tools/hook/index`, `tools/options →
tools/server/index`, `tools/waits → tools/pane/index`.
Rediraffe's check-diff builder confirms each old URL still
resolves.
- **Three area-level intros restored** to the corresponding scope
`index.md` after code-review caught content the mechanical
split dropped: `buffer/index.md` now documents UUID-namespacing
and the deliberate absence of a `list_buffers` tool (OS-
clipboard leak prevention); `hook/index.md` explains the
"Why no `set_hook`?" design decision (FastMCP lifespan
teardown bypassed on `kill -9` / OOM, leak risk for persistent
user servers); `pane/wait-for-channel.md` restores the
`send_keys → wait_for_channel` composition pattern and the
`; status=$?; tmux wait-for -S NAME; exit $status`
load-bearing safety contract for edge-triggered waits.
- **One stale relative link fixed.** `pane/search-panes.md` now
points at `../../../CHANGES` (three directories up from the
new nesting) instead of the old `../../CHANGES`.
Supersedes the earlier, stale `docs-overhaul-april-early-2026`
branch (PR #12, closed unmerged) — re-derived from current main
rather than rebased. Uses gp-sphinx's upstream
`sphinx-autodoc-fastmcp` directives, not the local autodoc the
earlier branch proposed.63 files changed
Lines changed: 2247 additions & 1893 deletions
File tree
- docs
- tools
- buffer
- hook
- pane
- server
- session
- window
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
80 | 80 | | |
81 | 81 | | |
82 | 82 | | |
83 | | - | |
84 | | - | |
85 | | - | |
86 | | - | |
87 | | - | |
88 | | - | |
89 | | - | |
90 | | - | |
91 | | - | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
92 | 92 | | |
93 | 93 | | |
94 | 94 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
0 commit comments