docs(index,import): Add comparison to toctree and update import notes

tony · tony · commit 080b5312dacb · 2026-03-16T17:31:33.000-05:00
why: Comparison page needs discovery path and importers need improvement notes.
what:
- Add comparison to docs/index.md Project toctree
- Add importer improvement notes for teamocil and tmuxinator
diff --git a/docs/cli/import.md b/docs/cli/import.md
@@ -38,6 +38,14 @@ $ tmuxp import teamocil /path/to/file.json
 
 ````
 
+### Importer improvements
+
+The teamocil importer now supports:
+
+- **v1.x format** — `windows` at top level with `commands` key in panes
+- **Focus** — `focus: true` on windows and panes is preserved
+- **Window options** — `options` on windows are passed through
+
 (import-tmuxinator)=
 
 ## From tmuxinator
@@ -71,3 +79,13 @@ $ tmuxp import tmuxinator /path/to/file.json
 ```
 
 ````
+
+### Importer improvements
+
+The tmuxinator importer now supports:
+
+- **Hook mapping** — `pre` maps to `on_project_start`, `pre_window` maps to `shell_command_before`
+- **CLI args** — `cli_args` values (`-f`, `-S`, `-L`) are parsed into tmuxp config equivalents
+- **Synchronize** — `synchronize` window key is converted
+- **Startup focus** — `startup_window` / `startup_pane` convert to `focus: true`
+- **Named panes** — hash-key pane syntax converts to `title` on the pane
diff --git a/docs/index.md b/docs/index.md
@@ -37,6 +37,7 @@ api/index
 history
 migration
 about_tmux
+Comparison <comparison>
 glossary
 GitHub <https://github.com/tmux-python/tmuxp>
 ```
diff --git a/tests/docs/examples/__init__.py b/tests/docs/examples/__init__.py
@@ -0,0 +1 @@
+"""Tests for example workspace YAML files."""
diff --git a/tests/docs/examples/test_examples.py b/tests/docs/examples/test_examples.py
@@ -3,7 +3,6 @@
 from __future__ import annotations
 
 import functools
-import typing as t
 
 from libtmux.pane import Pane
 from libtmux.session import Session

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+"""Tests for example workspace YAML files."""`