Files
worklane/docs/INDEX.md
T

47 lines
3.1 KiB
Markdown

# worklane docs
Why worklane is built the way it is, one file per subject. This is the reference for
someone changing worklane's own code: every rule here carries the reason it exists and
what broke without it, so read the entry before changing what it describes.
**How to *use* worklane is not here.** That is `assets/SKILL.md`, the document
`worklane install-skill` ships, along with `assets/REVIEW.md`, `assets/PLAN.md` and
`assets/ADMIN.md` for the three jobs done with it. Do not restate any of them here: a
second copy is a copy that goes stale.
## The data
| File | What it answers |
|---|---|
| [ticket-format.md](ticket-format.md) | What a ticket file holds, the metadata fields and the four stamps, how the statuses move it, how a column is ordered, and the four tiers that resolve a search to one ticket |
| [campaigns.md](campaigns.md) | The container that groups tickets across the flow, why its state is derived rather than stored, and where membership lives |
| [relations.md](relations.md) | Recording an edge between two tickets, which direction is stored, the two dependency guards, and how the block is drawn in both renderers |
| [history.md](history.md) | Who an entry is attributed to, the kinds, what is deliberately not logged, and how the old comments directory is adopted |
| [shared-boards.md](shared-boards.md) | The two board layouts, the machine config, the committed pointer, `decide_init`'s table, and how `find_worklane_dir` classifies what it finds |
## The CLI
| File | What it answers |
|---|---|
| [cli-arguments.md](cli-arguments.md) | Which arguments carry `allow_hyphen_values` and which deliberately do not, the empty-value parsers, and the `ls` filters |
| [editing-tickets.md](editing-tickets.md) | `set` against `append`, the one-field-one-writer rule, `--clear`, and ticking a criterion |
| [completions.md](completions.md) | The clap half and the fish half, what the dynamic values cost, and the tests that keep the lists honest |
| [color.md](color.md) | The palette, what each colour is reserved for, the tag colours, and why `color_text` must not be reached from the body |
## The board
| File | What it answers |
|---|---|
| [tui-board.md](tui-board.md) | The columns, the cards, the campaign and tag frames, the pickers, the footer, the hidden terminal columns, and the tabs when several boards are monitored |
| [tui-prompts.md](tui-prompts.md) | The search prompt, the command prompt and its recall, the line splitter behind them, and the copy key |
## The repo
| File | What it answers |
|---|---|
| [architecture.md](architecture.md) | What each `src/` file owns, and the organisation rules that put a function where it is |
| [testing.md](testing.md) | `make check`, the fixtures, and the measured rustfmt and clippy settings |
| [rust-style.md](rust-style.md) | The small conventions this tree keeps in its Rust, including when a command takes an `Args` struct |
| [agent-assets.md](agent-assets.md) | The documents and the opencode tool file the binary embeds, and how `install-skill` and `install-tool` place them |
| [releasing.md](releasing.md) | The commit format, and which changes warrant which version bump |