Skip to content

Commit 6dd0024

Browse files
committed
docs(sections): add grid cards to configuration and internals index pages
why: Configuration and Internals were the only section indexes without grid cards at the top. Configuration had cards at the bottom but not above the fold. All other sections (CLI, Topics, Project) have cards immediately after the heading. what: - configuration/index.md: add 1x3 responsive card grid at top linking to Top-level Options, Environment Variables, and Examples - internals/index.md: add 1x2 responsive card grid for Architecture and Python API, hide toctree for sidebar-only nav
1 parent c956490 commit 6dd0024

2 files changed

Lines changed: 41 additions & 1 deletion

File tree

docs/configuration/index.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,29 @@
66

77
# Workspace files
88

9+
::::{grid} 1 2 3 3
10+
:gutter: 2 2 3 3
11+
12+
:::{grid-item-card} Top-level Options
13+
:link: top-level
14+
:link-type: doc
15+
Session and window configuration keys.
16+
:::
17+
18+
:::{grid-item-card} Environment Variables
19+
:link: environmental-variables
20+
:link-type: doc
21+
TMUXP_CONFIGDIR and other env vars.
22+
:::
23+
24+
:::{grid-item-card} Examples
25+
:link: examples
26+
:link-type: doc
27+
Sample workspace configurations.
28+
:::
29+
30+
::::
31+
932
tmuxp loads your terminal workspace into tmux using workspace files.
1033

1134
The workspace file can be JSON or YAML. It's declarative style resembles tmux's object hierarchy: session, window and panes.

docs/internals/index.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,25 @@ If you are building an application with tmuxp, use the [CLI](../cli/index.md)
1111
or refer to the [libtmux API](https://libtmux.git-pull.com/api/).
1212
```
1313

14+
::::{grid} 1 1 2 2
15+
:gutter: 2 2 3 3
16+
17+
:::{grid-item-card} Architecture
18+
:link: architecture
19+
:link-type: doc
20+
How the CLI dispatches to the workspace builder and libtmux.
21+
:::
22+
23+
:::{grid-item-card} Python API
24+
:link: api/index
25+
:link-type: doc
26+
Internal module reference for contributors and plugin authors.
27+
:::
28+
29+
::::
30+
1431
```{toctree}
15-
:maxdepth: 2
32+
:hidden:
1633
1734
architecture
1835
api/index

0 commit comments

Comments
 (0)