| 1 | # How-tos -- INDEX |
| 2 | |
| 3 | Live catalog of analysis-derived how-tos for the |
| 4 | mirror-netdata-repos skill. |
| 5 | |
| 6 | **Live-catalog rule** (also stated in `../SKILL.md`): if an |
| 7 | assistant is asked a concrete question about the mirror that |
| 8 | required non-trivial analysis (multiple file reads, running |
| 9 | the script with custom flags, debugging a failed sync) AND |
| 10 | the answer is not already documented in `../SKILL.md`, the |
| 11 | assistant MUST author a new `how-tos/<slug>.md` and add a row |
| 12 | to this INDEX BEFORE completing the task. |
| 13 | |
| 14 | This is durable. Skipping it means the next assistant repeats |
| 15 | the same analysis from scratch. |
| 16 | |
| 17 | ## Catalog |
| 18 | |
| 19 | (empty -- entries grow as assistants encounter |
| 20 | not-yet-documented questions) |
| 21 | |
| 22 | | Topic | Slug | Notes | |
| 23 | |---|---|---| |
| 24 | | -- | -- | -- | |
| 25 | |
| 26 | ## How to add a how-to |
| 27 | |
| 28 | 1. Create `how-tos/<slug>.md` with: |
| 29 | - One-line summary at the top (the question being answered). |
| 30 | - The answer with file/line citations into the script if |
| 31 | relevant. |
| 32 | - A "How I figured this out" footer naming the files read |
| 33 | and the commands run. |
| 34 | 2. Add a row to the table above with topic, slug, short notes. |
| 35 | 3. Commit alongside the work that prompted the analysis. |
| 36 | |
| 37 | ## When NOT to add a how-to |
| 38 | |
| 39 | - The question is already covered by SKILL.md. |
| 40 | - The answer is a one-liner. |
| 41 | - The answer is highly speculative or version-specific. |