X-Git-Url: https://git.giacomolli.uk/onechat/blobdiff_plain/80fa33c0fd65e4110f88f0cab9b19ca26c27d1f6..48d7bce28b18ecef4c52c98821675605464cecb9:/.agents/skills/docs/SKILL.md?ds=inline

diff --git a/.agents/skills/docs/SKILL.md b/.agents/skills/docs/SKILL.md
index b802f77..2f7f3dc 100644
--- a/.agents/skills/docs/SKILL.md
+++ b/.agents/skills/docs/SKILL.md
@@ -9,6 +9,12 @@ description: Docs and comment rules. Use before you write any prose.
 
 - `README.rst` is the entry point. It says what OneChat is, its status,
   and how to build, run, and check it. Keep it short.
+- Write the README for the user: what to set up, which commands to run,
+  and what the agent does, in the user's words. A new feature adds at
+  most a few lines to it.
+- Keep internals out of the README: internal files and their formats,
+  locks, queues, recovery after a stop, limits, and edge cases. Put them
+  in the Go doc comments of the code that owns them.
 - Do not add other documentation files or a `docs/` folder. Document
   commands and flags in the command help, and code contracts and design
   reasons in Go doc comments.