ldraney/tmux-custom
1
0
Fork 0
Code Issues 3 Pull requests 3 Projects Releases Packages Wiki Activity Actions

Add plugins and config docs, rewrite README as TOC #7

New issue
Closed
opened 2026-06-12 04:41:52 +00:00 by ldraney · 0 comments
ldraney commented 2026-06-12 04:41:52 +00:00
Owner
Copy link

Type

Feature

Lineage

Standalone -- continuing docs/ buildout from #5.

Repo

ldraney/tmux-custom

User Story

As a tmux user
I want documented plugins, config reference, and a README that serves as a table of contents
So that I can quickly understand what my setup does without reading raw config

Context

First PR (#6) added session management docs. This continues the docs/ buildout with plugin documentation and a config walk-through. README is rewritten from a bare feature list to a proper entry point linking to docs/.

File Targets

Files to modify or create:

  • docs/plugins.md -- new, documents all TPM plugins with keybindings and overrides
  • docs/config-reference.md -- new, annotated walk-through of .tmux.conf
  • README.md -- rewrite as setup + TOC + feature summary

Files NOT to touch:

  • .tmux.conf -- no config changes

Feature Flag

none

Acceptance Criteria

  • docs/plugins.md covers all 7 plugins with purpose and keybindings
  • docs/config-reference.md walks through .tmux.conf sections
  • README.md links to all docs and has setup instructions
  • Config overrides (post-plugin settings) are documented

Test Expectations

  • Markdown renders correctly
  • Plugin descriptions match actual installed plugins in .tmux.conf

Constraints

  • Philosophy-first: explain why each plugin is there, not just what it does
  • README stays concise -- details go in docs/

Checklist

  • PR opened
  • No unrelated changes

Related

  • Standalone -- no project page yet
### Type Feature ### Lineage Standalone -- continuing docs/ buildout from #5. ### Repo `ldraney/tmux-custom` ### User Story As a tmux user I want documented plugins, config reference, and a README that serves as a table of contents So that I can quickly understand what my setup does without reading raw config ### Context First PR (#6) added session management docs. This continues the docs/ buildout with plugin documentation and a config walk-through. README is rewritten from a bare feature list to a proper entry point linking to docs/. ### File Targets Files to modify or create: - `docs/plugins.md` -- new, documents all TPM plugins with keybindings and overrides - `docs/config-reference.md` -- new, annotated walk-through of .tmux.conf - `README.md` -- rewrite as setup + TOC + feature summary Files NOT to touch: - `.tmux.conf` -- no config changes ### Feature Flag none ### Acceptance Criteria - [ ] `docs/plugins.md` covers all 7 plugins with purpose and keybindings - [ ] `docs/config-reference.md` walks through .tmux.conf sections - [ ] `README.md` links to all docs and has setup instructions - [ ] Config overrides (post-plugin settings) are documented ### Test Expectations - [ ] Markdown renders correctly - [ ] Plugin descriptions match actual installed plugins in .tmux.conf ### Constraints - Philosophy-first: explain why each plugin is there, not just what it does - README stays concise -- details go in docs/ ### Checklist - [ ] PR opened - [ ] No unrelated changes ### Related - Standalone -- no project page yet
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
feature/session-reorder
kitty-tmux-optimization
arch-linux
1-revert-to-minimal-config
No results found.
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
ldraney/tmux-custom#7
No description provided.