| 1 | # How-tos -- INDEX |
| 2 | |
| 3 | Live catalog of analysis-derived how-tos for the |
| 4 | query-agent-events skill. |
| 5 | |
| 6 | **Live-catalog rule** (also stated in `../SKILL.md`): if an |
| 7 | assistant is asked a concrete question about agent-events |
| 8 | that requires non-trivial analysis (multiple file reads, |
| 9 | multiple queries, cross-referencing producer source) AND the |
| 10 | answer is not already documented in the per-domain guides |
| 11 | (`../AE_FIELDS.md`, `../transports.md`, `../update-cadence.md`, |
| 12 | `../query-discipline.md`, `../finding-crashes.md`, |
| 13 | `../finding-fatals.md`) or the recipes (`../recipes/`), the |
| 14 | assistant MUST author a new `how-tos/<slug>.md` and add a |
| 15 | one-line entry to this INDEX BEFORE completing the task. |
| 16 | |
| 17 | This is durable. Skipping it means the next assistant repeats |
| 18 | the same analysis from scratch. |
| 19 | |
| 20 | ## Catalog |
| 21 | |
| 22 | (empty -- entries grow as assistants encounter |
| 23 | not-yet-documented questions) |
| 24 | |
| 25 | | Topic | Slug | Notes | |
| 26 | |---|---|---| |
| 27 | | -- | -- | -- | |
| 28 | |
| 29 | ## How to add a how-to |
| 30 | |
| 31 | 1. Create `how-tos/<slug>.md` with: |
| 32 | - One-line summary at the top (the question being answered). |
| 33 | - The answer with `path:line` citations into producer source |
| 34 | where appropriate. |
| 35 | - A "How I figured this out" footer naming the files read, |
| 36 | the queries run (with payloads), and the helpers used. |
| 37 | 2. Add a row to the table above with topic, slug, short notes. |
| 38 | 3. Commit alongside the work that prompted the analysis. |
| 39 | |
| 40 | ## When NOT to add a how-to |
| 41 | |
| 42 | - The question is already covered by an existing per-domain |
| 43 | guide or recipe -- update that guide instead. |
| 44 | - The answer is a one-liner. |
| 45 | - The answer is highly speculative or version-specific. |