Skip to content

Commit 8831963

Browse files
committed
docs: Update index with new navigation structure
why: The old nav (quickstart, about, topics, api) was flat and mixed concerns. The new layered nav (Getting Started, Tools, Guides, Reference, Project) matches the pattern used by top MCP servers. what: - Rewrite docs/index.md with 5-section toctree - Remove docs/about.md (content distributed to concepts, architecture, tools/index, safety, and configuration)
1 parent ae4b79e commit 8831963

2 files changed

Lines changed: 34 additions & 247 deletions

File tree

docs/about.md

Lines changed: 0 additions & 241 deletions
This file was deleted.

docs/index.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,22 +14,50 @@ MCP server for tmux, powered by [libtmux](https://libtmux.git-pull.com/).
1414
```
1515

1616
```{toctree}
17+
:caption: Getting Started
1718
:maxdepth: 2
1819
:hidden:
1920
21+
installation
2022
quickstart
21-
about
22-
topics/index
23-
api/index
23+
clients
24+
concepts
25+
configuration
26+
safety
2427
```
2528

2629
```{toctree}
27-
:caption: Project
30+
:caption: Tools
31+
:maxdepth: 2
2832
:hidden:
2933
30-
developing
34+
tools/index
35+
```
36+
37+
```{toctree}
38+
:caption: Guides
39+
:maxdepth: 2
40+
:hidden:
41+
42+
guides/troubleshooting
43+
```
44+
45+
```{toctree}
46+
:caption: Reference
47+
:maxdepth: 2
48+
:hidden:
49+
50+
reference/api/index
51+
reference/compatibility
3152
history
53+
```
54+
55+
```{toctree}
56+
:caption: Project
57+
:hidden:
58+
59+
architecture
60+
development
3261
glossary
3362
GitHub <https://github.com/tmux-python/libtmux-mcp>
3463
```
35-

0 commit comments

Comments
 (0)