From 0a6d6daf0b0b00f7505ab159920981474e0d2310 Mon Sep 17 00:00:00 2001 From: Amolith Date: Wed, 22 Oct 2025 14:33:13 -0600 Subject: [PATCH] docs: elaborate on resumption --- README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 0ccb38ba69fa659cce4f638433fcd9e631ad03ac..9dea14fa25d1e2003e3fb372cb7d3828d8743cd4 100644 --- a/README.md +++ b/README.md @@ -46,16 +46,17 @@ you know will be relevant as possible. Mention particular symbols, paste snippets of code, etc. Once your prompt looks good, send it off. In the `np` section of the model's rules, we'll have instructions to -_immediately_ run `np s`, which outputs some LLM-oriented instructions for use. -Each command further in the flow reveals the next step as instructions. `np s` -tells the model to set an overarching goal with `np g s -t title -d description` -that captures the operator's request, combining the information from the ticket -and any extra operator-provided context. The output of `np g s` says to look at -the provided references, thoroughly consider how to go about resolving the goal, -and gather additional context from other files if necessary. Once it has a good -idea how to resolve the goal, it should add some tasks with `np t a -t title -d +_immediately_ run start a session if the operator says to `use np` or something +similar. Each command further in the flow reveals the next step as instructions. +`np s` tells the model to set an overarching goal with `np g s -t title -d +description` that captures the operator's request, combining the information +from the ticket and any extra operator-provided context. If there's a ticket ID, +that goes in the goal description. The output of `np g s` says to look at the +provided references, thoroughly consider how to go about resolving the goal, and +gather additional context from other files if necessary. Once it has a good idea +how to resolve the goal, it should add some tasks with `np t a -t title -d description -t title2 -d description2`. The descriptions are good places to -references files and symbols. The output of `np t a` tells it to update tasks as +reference files and symbols. The output of `np t a` tells it to update tasks as it works on them with something like `np t u -i task-id -s status`. Commands that modify the model's goal or list output the full changed plan @@ -66,11 +67,11 @@ descs) and use `np t -s status` to filter to `pending`, `in progress`, `completed`, `all`, etc. tasks, but usually doesn't need to because we immediately show it after every modification. -Resume an interrupted session in a new context window by typing your own -instructions on what to do next _and_ telling the model to run `np r`. This -outputs the full plan, provides relevant usage instructions, and tells the model -to read the files/symbols referenced in the pending tasks to get a good idea of -what work is left. +Resume an interrupted session in a _new_ context window by telling the model to +run `np r`. This outputs the full plan, provides relevant usage instructions, +and tells the model to "check above" for a bug/issue/ticket ID in the goal +description. If present, read that. Then read the files/symbols referenced in +the pending tasks to get a good idea of what work is left. Once finished, the operator or model (I'm not sure which yet, see next section) archives the session with `np a`.