# MasterBot - LLM documentation maintenance

Rules for humans and AI agents updating MasterBot's public LLM files (`public/llms*.txt`).

Index: https://masterbot.gg/llms.txt  
Full repo guide: docs/guides/LLMS_DOCUMENTATION_MAINTENANCE.md

---

## Quick regenerate

```bash
npm run generate:llms
```

Runs automatically on `npm run build`. Deploy after merge so https://masterbot.gg/llms-full.txt updates.

---

## Generated vs hand-edited

| File | How to update |
|------|----------------|
| `llms-nodes.txt` | Auto - nodeTemplates.ts |
| `llms-node-parameters.txt` | Auto - nodeTemplates.ts (**stable only**) |
| `llms-events.txt` | Auto - discordEventCatalog.ts, customEventCatalog.ts |
| `llms-variables.txt` | Auto - defaultBotVariableDefinitions.ts |
| `llms-pricing.txt` | Auto - entitlementLimitsPublic.ts, entitlement-limits.ts |
| `llms-competitors.txt` | Auto - competitorFeatureComparison.ts |
| `llms-full.txt` | Auto - bundles all sections |
| `llms.txt` | Hand - index and agent read order |
| `llms-capabilities.txt` | Hand - high-level capabilities |
| `llms-platform.txt` | Hand - navigation recipes |
| `llms-flow-builder.txt` | Hand - builder UI |
| `llms-support.txt` | Hand - support tiers |
| `llms-status.txt` | Hand - status API pointers |
| `llms-maintenance.txt` | Hand - this file |
| `ai.html` | Hand - agent landing page |

---

## Node parameters policy (important)

1. **Catalog** (`llms-nodes.txt`) lists **stable + beta** palette nodes.
2. **Parameters** (`llms-node-parameters.txt`) include **stable nodes only**.
3. **Beta nodes** - parameters are **not** published. Layout and sidebar fields may change.
4. When a node graduates **beta to stable** in `nodeTemplates.ts`:
   - Set `status: 'stable'`
   - Run `npm run generate:llms`
   - Parameters appear automatically on next build/deploy

No manual edit of `llms-node-parameters.txt` - always regenerate.

---

## When to regenerate (checklist)

Run `npm run generate:llms` after:

- [ ] New node added or node description changed in `nodeTemplates.ts`
- [ ] Node promoted **beta to stable** (parameters export unlocks)
- [ ] Node `parameters` array changed on a **stable** node
- [ ] Discord event verified and added to production catalog
- [ ] BOT variable added/changed in `defaultBotVariableDefinitions.ts`
- [ ] Tier limit changed in `entitlement-limits.ts` / `entitlementLimitsPublic.ts`
- [ ] Competitor matrix row updated in `competitorFeatureComparison.ts`

Hand-edit `llms-platform.txt`, `llms-flow-builder.txt`, or `llms.txt` when UI navigation or agent instructions change.

---

## Prompt template (copy for Cursor / agents)

```
Update MasterBot LLM documentation per docs/guides/LLMS_DOCUMENTATION_MAINTENANCE.md and public/llms-maintenance.txt.

Changes in this task:
- [describe: e.g. promoted createChannel from beta to stable]

Do:
1. Apply code/catalog changes if not done yet
2. Run npm run generate:llms
3. Hand-update llms.txt / ai.html / vercel.json headers if new public file added
4. Do not edit generated llms-*.txt by hand
5. Beta node parameters stay excluded until status is stable
```

---

## Discovery files to keep in sync

When adding a **new** public llms file, also update:

- `public/llms.txt` (index)
- `public/ai.html`
- `public/robots.txt` comment block
- `public/sitemap.xml`
- `public/.well-known/llms.txt`
- `vercel.json` - explicit path header (no regex alternation)
- `scripts/generate-llms-txt.ts` - `LLMS_FULL_SECTIONS` array

---

## Do not

- Scrape the React SPA for LLM content
- Publish beta node parameters (wait for stable)
- Include competitor rows with `unknown` verification status
- Use regex alternation in vercel.json header `source` patterns
- Add "how to test your agent" copy to public llms files