agentilda 1.0.3 → 2.0.0

data/lib/agentilda/documentation.rb

@@ -40,8 +40,8 @@ module Agentilda
         > **This file is auto generated.**
         >
         > To regenerate it, run `agentilda docs` (which by the default
-        > writes to ${HOME}/.agents/context/workflow.md`). To override
-        > the destination, use the -o | --output <file> option.
+        > writes to `${HOME}/.agents/context/workflow.md`). To override
+        > the destination, use the `-o | --output <file>` option.
         >
         > After changing the state machine. Editing it by hand puts it back into the
         > condition it was written to end: three copies of the same table, quietly
@@ -195,7 +195,7 @@ module Agentilda
     # @return [String]
     def merged_note
       "🟣 Merged is deliberately **not** a folder state. It describes a pull request, " \
-      "and a folder that claimed it would be claiming a pull request's condition as its own."
+        "and a folder that claimed it would be claiming a pull request's condition as its own."
     end
 
     # Why this is prose rather than another derived table: the mechanism is a
@@ -309,9 +309,9 @@ module Agentilda
     # @return [String]
     def files_section
       known = Agentilda::STATUSES
-        .flat_map(&:requires)
-        .uniq
-        .map { |f| "| `#{f}` | #{holders_of(f)} |" }
+              .flat_map(&:requires)
+              .uniq
+              .map { |f| "| `#{f}` | #{holders_of(f)} |" }
 
       <<~MARKDOWN
         ## Files allowed in a plan folder
@@ -320,8 +320,16 @@ module Agentilda
         | :--- | :---------- |
         | `spec.md` | the specification; written first |
         | `plan.md` | the execution plan; written from the spec |
+        | `implementation-plan.md` | the contract between the two halves of building |
         #{known.reject { |r| r.start_with?("| `spec.md`", "| `plan.md`") }.join("\n")}
 
+        `implementation-plan.md` is the one file no state requires. `luke-backend`
+        writes it before it writes code, and `rey-frontend` builds from it a round
+        later: the interfaces the back end landed, their shapes and their errors,
+        which files each half owns, which units may run concurrently, and the one
+        test that proves the halves are joined rather than merely both present. No
+        state requires it because a plan with no back-end work never needs one.
+
         Nothing else belongs there. A folder holding notes, diagrams or scratch files
         is a folder nobody can audit at a glance.