Skip to content

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

Merged
AlemTuzlak merged 1 commit into
mainfrom
docs/config-timestamp-guidance
Jun 5, 2026
Merged

docs: require maintaining addedAt/updatedAt in docs config when touching docs#711
AlemTuzlak merged 1 commit into
mainfrom
docs/config-timestamp-guidance

Conversation

@AlemTuzlak
Copy link
Copy Markdown
Contributor

@AlemTuzlak AlemTuzlak commented Jun 5, 2026

What

Adds a convention to CLAUDE.md and AGENTS.md: when an agent touches a docs page, it must maintain that page's entry in docs/config.json.

  • New page → add the entry with addedAt (ISO YYYY-MM-DD) set to today.
  • Content change to an existing page (new section, capability, reworked guidance, new examples) → set/refresh updatedAt to today.
  • Bug fixes don't bump anything — typos, broken links, code-fence languages, formatting, and factual fixes must not touch addedAt or updatedAt.

This codifies the addedAt field introduced in #708 and establishes a companion updatedAt for content edits, while keeping pure fixes from churning the dates.

Notes

  • Documentation-only change to the two agent-guidance files; no code or docs/ content touched.
  • updatedAt is not back-filled here — entries gain it the first time their page receives a content change under the new rule.

No changeset (repo guidance only).

Summary by CodeRabbit

  • Documentation
    • Updated contributor guidelines for properly maintaining documentation metadata timestamps based on the type of change being made.

…ing docs

Document in CLAUDE.md and AGENTS.md that touching a docs page must update its docs/config.json entry: addedAt for new pages, updatedAt for content changes. Pure bug fixes (typos, broken links, code-fence languages, formatting) must not bump either date.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 5, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 23da553b-1b59-4e72-984b-203553351489

📥 Commits

Reviewing files that changed from the base of the PR and between 343e76d and ebf3c83.

📒 Files selected for processing (2)
  • AGENTS.md
  • CLAUDE.md

📝 Walkthrough

Walkthrough

Added guidance to AGENTS.md and CLAUDE.md specifying how contributors should manage addedAt and updatedAt timestamps in docs/config.json entries: set addedAt for new pages, refresh updatedAt for content changes, and preserve both dates for bug-fix edits.

Changes

Documentation timestamp guidance

Layer / File(s) Summary
Timestamp maintenance guidance for doc entries
AGENTS.md, CLAUDE.md
Both contributor guidance files add consistent documentation rules clarifying when to set, refresh, or preserve addedAt and updatedAt timestamps in docs/config.json: new pages set addedAt, content changes refresh updatedAt, bug fixes preserve both.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • TanStack/ai#708: Adds and updates addedAt entries in docs/config.json while this PR documents the rules for correctly managing those timestamp fields.

Poem

📝✨ A rabbit's guide to doc timestamps true,
When pages bloom anew, mark addedAt right through,
Let updatedAt dance when content flows fresh,
But typos and formats? Leave dates unmeshed! 🐰

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description clearly explains what/why/how with good detail. However, it does not follow the required template structure (missing Checklist and Release Impact sections). Add the Checklist section (Contributing guide confirmation and test confirmation) and Release Impact section to match the repository template.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately captures the main change: requiring maintenance of addedAt/updatedAt fields in docs config when modifying docs pages.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/config-timestamp-guidance

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 5, 2026

🚀 Changeset Version Preview

No changeset entries found. Merging this PR will not cause a version bump for any packages.

@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented Jun 5, 2026

View your CI Pipeline Execution ↗ for commit ebf3c83

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 10s View ↗
nx run-many --targets=build --exclude=examples/... ✅ Succeeded 2s View ↗

☁️ Nx Cloud last updated this comment at 2026-06-05 10:38:36 UTC

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Jun 5, 2026

Open in StackBlitz

@tanstack/ai

npm i https://pkg.pr.new/@tanstack/ai@711

@tanstack/ai-anthropic

npm i https://pkg.pr.new/@tanstack/ai-anthropic@711

@tanstack/ai-client

npm i https://pkg.pr.new/@tanstack/ai-client@711

@tanstack/ai-code-mode

npm i https://pkg.pr.new/@tanstack/ai-code-mode@711

@tanstack/ai-code-mode-skills

npm i https://pkg.pr.new/@tanstack/ai-code-mode-skills@711

@tanstack/ai-devtools-core

npm i https://pkg.pr.new/@tanstack/ai-devtools-core@711

@tanstack/ai-elevenlabs

npm i https://pkg.pr.new/@tanstack/ai-elevenlabs@711

@tanstack/ai-event-client

npm i https://pkg.pr.new/@tanstack/ai-event-client@711

@tanstack/ai-fal

npm i https://pkg.pr.new/@tanstack/ai-fal@711

@tanstack/ai-gemini

npm i https://pkg.pr.new/@tanstack/ai-gemini@711

@tanstack/ai-grok

npm i https://pkg.pr.new/@tanstack/ai-grok@711

@tanstack/ai-groq

npm i https://pkg.pr.new/@tanstack/ai-groq@711

@tanstack/ai-isolate-cloudflare

npm i https://pkg.pr.new/@tanstack/ai-isolate-cloudflare@711

@tanstack/ai-isolate-node

npm i https://pkg.pr.new/@tanstack/ai-isolate-node@711

@tanstack/ai-isolate-quickjs

npm i https://pkg.pr.new/@tanstack/ai-isolate-quickjs@711

@tanstack/ai-mcp

npm i https://pkg.pr.new/@tanstack/ai-mcp@711

@tanstack/ai-ollama

npm i https://pkg.pr.new/@tanstack/ai-ollama@711

@tanstack/ai-openai

npm i https://pkg.pr.new/@tanstack/ai-openai@711

@tanstack/ai-openrouter

npm i https://pkg.pr.new/@tanstack/ai-openrouter@711

@tanstack/ai-preact

npm i https://pkg.pr.new/@tanstack/ai-preact@711

@tanstack/ai-react

npm i https://pkg.pr.new/@tanstack/ai-react@711

@tanstack/ai-react-ui

npm i https://pkg.pr.new/@tanstack/ai-react-ui@711

@tanstack/ai-solid

npm i https://pkg.pr.new/@tanstack/ai-solid@711

@tanstack/ai-solid-ui

npm i https://pkg.pr.new/@tanstack/ai-solid-ui@711

@tanstack/ai-svelte

npm i https://pkg.pr.new/@tanstack/ai-svelte@711

@tanstack/ai-utils

npm i https://pkg.pr.new/@tanstack/ai-utils@711

@tanstack/ai-vue

npm i https://pkg.pr.new/@tanstack/ai-vue@711

@tanstack/ai-vue-ui

npm i https://pkg.pr.new/@tanstack/ai-vue-ui@711

@tanstack/openai-base

npm i https://pkg.pr.new/@tanstack/openai-base@711

@tanstack/preact-ai-devtools

npm i https://pkg.pr.new/@tanstack/preact-ai-devtools@711

@tanstack/react-ai-devtools

npm i https://pkg.pr.new/@tanstack/react-ai-devtools@711

@tanstack/solid-ai-devtools

npm i https://pkg.pr.new/@tanstack/solid-ai-devtools@711

commit: ebf3c83

@AlemTuzlak AlemTuzlak merged commit 712b76d into main Jun 5, 2026
10 checks passed
@AlemTuzlak AlemTuzlak deleted the docs/config-timestamp-guidance branch June 5, 2026 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant