Commit 097a9ae
authored
docs: document orphan-YAML gate + --allow-new-files in README and AGENTS (#31)
Followup to PR #30 (orphan-YAML pre-flight gate). The gate landed in
the engine but neither README.md nor AGENTS.md mentioned the new
default-on behavior or the --allow-new-files override. Agents and
human operators reading those docs would hit the gate unexpectedly.
README.md:
- Updated push command-table row to mention the gate + flag
- New "Creating new resources after the first push (orphan-YAML gate)"
section under Suggested Workflows, explaining the three cases (new /
rename / cruft), the --allow-new-files override, and the AI-agent
caveat (do NOT auto-pass without confirming)
- Documents the automatic suppressions (--bootstrap, .vapi-ignore,
selective-push scope)
AGENTS.md:
- Common commands table row for "Push with new resources" with the
--allow-new-files flag + explicit AI-agent caveat
- New "Orphan-YAML gate" subsection under "npm run push" explaining
the gate behavior, override flag, AI-agent guidance, and suppression
rules. Notes that the same gate fires inside `apply` and the flag
propagates through `apply --allow-new-files`
- New bash command-block lines for `npm run push --allow-new-files`
and `npm run apply --allow-new-files`
Docs-only PR. Skipping test-writer and code-reviewer per the
always-apply rule for docs-only changes.1 parent 3075218 commit 097a9ae
2 files changed
Lines changed: 46 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
68 | 68 | | |
69 | 69 | | |
70 | 70 | | |
| 71 | + | |
71 | 72 | | |
72 | 73 | | |
73 | 74 | | |
| |||
97 | 98 | | |
98 | 99 | | |
99 | 100 | | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
100 | 118 | | |
101 | 119 | | |
102 | 120 | | |
| |||
812 | 830 | | |
813 | 831 | | |
814 | 832 | | |
| 833 | + | |
815 | 834 | | |
| 835 | + | |
816 | 836 | | |
817 | 837 | | |
818 | 838 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
75 | 75 | | |
76 | 76 | | |
77 | 77 | | |
78 | | - | |
| 78 | + | |
79 | 79 | | |
80 | 80 | | |
81 | 81 | | |
| |||
186 | 186 | | |
187 | 187 | | |
188 | 188 | | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
189 | 214 | | |
190 | 215 | | |
191 | 216 | | |
| |||
0 commit comments