diff --git a/AGENTS.md b/AGENTS.md index 1dd7ecce1..13d918e3d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -59,6 +59,14 @@ When editing docs under `docs/`: include snippets for both halves (server endpoint AND client consumption). - **Use the latest model per provider**, sourced from each adapter's `model-meta.ts` (newest `gpt-*`, `claude-*`, `gemini-*`, …), in example code. +- **Maintain `addedAt` / `updatedAt` on docs entries in `docs/config.json`.** + Every page entry carries an `addedAt` (ISO `YYYY-MM-DD`) and, once edited, an + `updatedAt`. When you touch a docs page, update its entry: add a new entry + with `addedAt` set to today's date for a **new page**, or set/refresh + `updatedAt` to today's date when you make a **content change** to an existing + page (new section, capability, reworked guidance, new examples). **Bug fixes + don't bump anything** — typos, broken links, code-fence languages, + formatting, and factual fixes must not touch `addedAt` or `updatedAt`. - Run `pnpm test:docs` (link verification) before pushing. ## Everything Else diff --git a/CLAUDE.md b/CLAUDE.md index a6ece3b8f..f1fa41281 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -333,6 +333,17 @@ OPENAI_API_KEY=sk-... pnpm --filter @tanstack/ai-e2e record - **Use the latest model per provider in examples**, sourced from each adapter's `model-meta.ts` (the newest `gpt-*`, `claude-*`, `gemini-*`, etc.). Don't introduce superseded model ids in new or edited samples. +- **Maintain `addedAt` / `updatedAt` on docs entries in `docs/config.json`.** + Every page entry carries an `addedAt` (ISO `YYYY-MM-DD`) and, once edited, + an `updatedAt`. When you touch a docs page, update its entry: + - **New page** → add the entry with `addedAt` set to today's date. + - **Content change** to an existing page (new section, new capability, + reworked guidance, new examples) → set/refresh `updatedAt` to today's + date. + - **Bug fixes don't bump anything.** Pure corrections — typos, broken + links, code-fence languages, formatting, factual fixes — must **not** + touch `addedAt` or `updatedAt`. Only genuinely new or changed content + moves these dates. ## Key Dependencies