Skip to content

docs: require maintaining addedAt/updatedAt in docs config when touching docs #711

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlemTuzlak merged 1 commit into from
Jun 5, 2026
Merged

docs: require maintaining addedAt/updatedAt in docs config when touching docs #711

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 11 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading