From 70741165076e057491a1e6581b417e4e6afc3525 Mon Sep 17 00:00:00 2001 From: Amolith Date: Wed, 22 Oct 2025 13:41:50 -0600 Subject: [PATCH] docs: flesh out a bit more --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 7b23eb5249df47b2d791be981a24f67aad9d463d..bbcd657d753f52989ce124a0d1f2d13802310f8a 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,23 @@ command before the model can create a new session. Maybe telling it about the archival command, but to never run it without operator interaction, would be sufficient. +Every LLM-oriented sub-command is tracked as an event in a global SQLite +database in `$XDG_CONFIG_HOME/nasin-pona/`. Sub-commands that do anything to +modify either created tasks or set goals require a reason ("operator said so" is +insufficiently detailed, but otherwise acceptable). + +The interactive, human-focused sub-commands are for watching these events and +the resulting list as they change in realtime, and for exporting a session with +all of its events as Markdown. The goal and description and tasks and their +descriptions are rendered at the top of the UI and updated based on database +events using some Charm libraries. Change events are underneath the rendered +state, sorted most recent (top) to least recent (bottom). + +Each session is working-directory-scoped so the model doesn't have to provide a +session ID or something for each invocation. This is why there are `np s` and +`np a` commands for `s`tarting and `a`rchiving a session. Worktrees allow for +parallel sessions. + ## The name Is [toki pona](https://tokipona.org/). [_nasin_](https://nimi.li/nasin) occupies