"Complete the project" feature should be updating documentation #232
Loading…
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
I'm doing the first real experiment with the combination of "Auto-plan" and "Complete the project". The first problem I noticed is that the agent is on the 3rd issue and the repo has no documentation whatsoever.
One big mission of Braid is transparency. Its why we have the live coding agent that can be interrupted and resumed. So for the case of auto-plan and complete the project, the user should have a way to go behind the agent and test out the software that exists. Without documentation, I'd have to ask the agent how to use it, or infer it myself from the code.
I think there should be an extra step added to the graph to update README at a minimum, and any other documentation the project my have. This could happen just before or just after the plan.next step. There should be some guidance given for the readme, to keep it short and sweet, but still informative enough to be able to test it, and get a good idea what it is and perhaps even how it looks (if relevant). If it already exists, then it should be updated to be correct.
I realize now that that there was a README with install instructions, so it is working well. It may still be worth having a new step specifically to ensure that docs are kept up to date.
What shipped
No new step: the README is now part of what the fix loop checks.
Shipped in
5598ddf(OpenSpec changechecks-that-match-the-brief, archived).