docs(todo): reorder queued tasks and update workon description
All checks were successful
CI / Test (push) Successful in 33s
CI / Lint (push) Successful in 24s
CI / Build (push) Successful in 19s

- Introduce 'workon' as the top queued item for bootstrapping new features
- Rearrange other queued items (e.g., cnotes, make, rg) and mark some as optional
- Remove TODO_ITEM template from queued list
- Expand workon.md with detailed description, usage, assumptions, and benefits
This commit is contained in:
Gregory Gauthier 2026-03-31 14:44:46 +01:00
parent eb9bc410fc
commit 3bcba4976a
2 changed files with 27 additions and 9 deletions

View File

@ -4,18 +4,18 @@ This document provides a table of contents for all tasks and features currently
## Queued ## Queued
* [1] [interactive-agent.md](./queued/interactive-agent.md) : Grokkit Interactive Agent * [1] [workon](./queued/workon.md): Grokkit workon for bootstrapping a new feature
* [2] [rg.md](./queued/rg.md) : grokkit agent ripgrep (rg) integration * [2] [cnotes.md](./queued/cnotes.md) : grokkit cnotes integration
* [3] [gotools.md](./queued/gotools.md) : grokkit agent Go tools integration * [3] [make.md](./queued/make.md) : grokkit make integration
* [4] [make.md](./queued/make.md) : grokkit agent make integration * [4] [rg.md](./queued/rg.md) : grokkit ripgrep (rg) integration
* [5] [tea.md](./queued/tea.md) : grokkit agent tea (Gitea CLI) integration * [5] [gotools.md](./queued/gotools.md) : grokkit Go tools integration
* [6] [cnotes.md](./queued/cnotes.md) : grokkit agent cnotes integration * [6] [tea.md](./queued/tea.md) : grokkit tea (Gitea CLI) integration
* [7] [profile.md](./queued/profile.md) : grokkit profile * [7] [profile.md](./queued/profile.md) : grokkit profile
* [8] [pprof.md](./queued/pprof.md) : grokkit agent pprof integration * [8] [pprof.md](./queued/pprof.md) : grokkit agent pprof integration
* [9] [audit.md](./queued/audit.md) : grokkit audit * [9] [audit.md](./queued/audit.md) : grokkit audit
* [10] [git-chglog.md](./queued/git-chglog.md) : grokkit agent git-chglog integration * [10] [git-chglog.md](./queued/git-chglog.md) : grokkit agent git-chglog integration
* [11] [admin.md](./queued/admin.md) : grokkit admin tool (to show token usage and other admin-only features) * [11] [admin.md](./queued/admin.md) : [optional] grokkit admin tool (to show token usage and other admin-only features)
* [99] [TODO_ITEM.md](./queued/TODO_ITEM.md) : TODO ITEM template * [12] [interactive-agent.md](./queued/interactive-agent.md) : [optional] Grokkit Interactive Agent
## Completed ## Completed

View File

@ -1,6 +1,24 @@
# `grokkit workon` # `grokkit workon`
**Description**: selects a todo item out of the todo queue; creates a branch based on the item; generates a plan for implementation. **Description**: Automates the initiation of new feature and fix development.
1. selects a todo item out of the todo queue;
2. creates a branch based on the item;
3. generates a plan for implementation;
4. commits the plan to the branch;
4. logs the beginning of the work using `cnadd` (if available).
5. opens the branch in the IDE (specified in the config).
**Usage**:
```
grokkit workon <todo_item_title> [-c <custom_commit_message>]
```
**Assumptions**:
Grokkit is being customized to suit my own development workflow. So, there are a number of features that may not be translatable to other developers' habits. As such, this feature assumes that the repository has a "todo" folder with a "queued", "doing" and "completed" subfolder, that function as the in-situ ticketing system. If the "todo" folder is not present, grokkit will create it.
Also, if no IDE is specified in the config, the feature will default to not opening the editor. If `cnadd` is not available, the feature will default to not logging the beginning of the work.
**Benefits**: **Benefits**: