Skip to content

docs: add TanStack AI banner to package READMEs - #1316

Merged
AlemTuzlak merged 1 commit into
mainfrom
docs/package-readme-banners
Sep 3, 2026
Merged

docs: add TanStack AI banner to package READMEs#1316
AlemTuzlak merged 1 commit into
mainfrom
docs/package-readme-banners

Conversation

@AlemTuzlak

@AlemTuzlak AlemTuzlak commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

npm package pages for 36 adapters now show the TanStack AI banner. New packages/*/README.md files must start with that same <picture> block.

🎯 Changes

  • Add the canonical https://tanstack.com/api/readme/ai.png banner to 35 package READMEs that had none.
  • Replace the old media/header_ai.png image on @tanstack/ai-cohere with the same <picture> banner.
  • Require that banner in AGENTS.md, CLAUDE.md, and CONTRIBUTING.md when an agent adds a package README.

Skipped: 13 packages that have no README yet (for example ai-anthropic, ai-fal). They get the banner when a README is added.

✅ Checklist

  • I have followed the steps in the Contributing guide.
  • I have tested code changes locally with pnpm run test:pr, or these tests do not apply to this pull request.
  • I fully understand the code in this pull request, including any code generated with AI assistance.
  • Docs: I updated docs/ for this change, or this change is not user-facing.
  • Changeset: I added a changeset (pnpm changeset), or this PR does not change a published package.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • This change is docs/CI/dev-only (no release).

Testing

  1. Commands run. pnpm exec oxfmt on the 39 changed files: pass. pnpm test:docs: fail on untracked leftover files under docs/superpowers/worktrees/, not on these READMEs. pnpm test:pr skipped: markdown and agent-instruction files only.
  2. Manual test.
    1. Open any changed file, for example packages/ai-cloudflare/README.md.
    2. Confirm the first block is the <picture> banner with tanstack.com/api/readme/ai.png.
    3. Open packages/ai-cohere/README.md and confirm header_ai.png is gone.
    4. Search AGENTS.md for Package README banner.
  3. How this PR makes testing easy. No automated test. The banner HTML is copied from packages/ai/README.md. Reviewer can grep tanstack.com/api/readme/ai.png vs header_ai.png.

Risk / rollback

Low. README and agent-instruction text only. Revert the PR to undo.

Summary by CodeRabbit

  • Documentation
    • Added a consistent, theme-aware TanStack AI banner to package README files.
    • Updated contribution and project guidance to require the banner for new or replaced package READMEs.
    • Clarified framework-specific banner options and exclusions for non-package documentation.
    • Added documentation for newly introduced sandbox and provider packages.

@coderabbitai

coderabbitai Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Team

Run ID: a1da4edd-8957-4707-94fe-c08a907a8af3

📥 Commits

Reviewing files that changed from the base of the PR and between dcc2b29 and 58d2900.

📒 Files selected for processing (39)
  • AGENTS.md
  • CLAUDE.md
  • CONTRIBUTING.md
  • packages/ai-acp/README.md
  • packages/ai-bedrock/README.md
  • packages/ai-byteplus/README.md
  • packages/ai-claude-code/README.md
  • packages/ai-cloudflare/README.md
  • packages/ai-code-mode-snippets/README.md
  • packages/ai-code-mode/README.md
  • packages/ai-codex/README.md
  • packages/ai-cohere/README.md
  • packages/ai-compaction/README.md
  • packages/ai-elevenlabs/README.md
  • packages/ai-grok-build/README.md
  • packages/ai-grok/README.md
  • packages/ai-groq/README.md
  • packages/ai-isolate-cloudflare/README.md
  • packages/ai-isolate-daytona/README.md
  • packages/ai-isolate-node/README.md
  • packages/ai-isolate-quickjs-bun/README.md
  • packages/ai-isolate-quickjs/README.md
  • packages/ai-llmgateway/README.md
  • packages/ai-lovable/README.md
  • packages/ai-mcp/README.md
  • packages/ai-mistral/README.md
  • packages/ai-octane/README.md
  • packages/ai-opencode/README.md
  • packages/ai-perplexity/README.md
  • packages/ai-react-ui/README.md
  • packages/ai-remix/README.md
  • packages/ai-sandbox-docker/README.md
  • packages/ai-sandbox-upstash-box/README.md
  • packages/ai-sandbox/README.md
  • packages/ai-solid-ui/README.md
  • packages/ai-vercel-gateway/README.md
  • packages/ai-vertex/README.md
  • packages/ai-vue-ui/README.md
  • packages/openai-base/README.md

Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review.


📝 Walkthrough

Walkthrough

The change defines mandatory TanStack AI banners for package READMEs, updates contributor guidance, adds responsive banners across package READMEs, and expands the Daytona isolate README with usage and validation documentation.

Changes

README banner standardization

Layer / File(s) Summary
Banner requirements
AGENTS.md, CLAUDE.md, CONTRIBUTING.md
Defines the required responsive TanStack AI banner and prohibits media/header_ai.png.
Package banner rollout
packages/ai-*/README.md, packages/openai-base/README.md
Adds centered banners with dark- and light-theme image variants, fallback images, and spacing markup.
Daytona README documentation
packages/ai-isolate-daytona/README.md
Documents installation, driver usage, configuration options, execution flow, requirements, and validation commands.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to 58d29

This change standardizes package README banners and contributor guidance without modifying runtime behavior. No current merge-blocking risk remains.

Suggested reviewers: tombeckenham

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the primary change: adding the TanStack AI banner to package README files.
Description check ✅ Passed The description includes the required Changes, Checklist, and Release Impact sections. It explains the README updates, documents skipped packages, records testing results, and correctly identifies the…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Description check

Explanation

The description includes the required Changes, Checklist, and Release Impact sections. It explains the README updates, documents skipped packages, records testing results, and correctly identifies the change as documentation-only with no release impact.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (39 skipped: 39 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/package-readme-banners

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.

@nx-cloud

nx-cloud Bot commented Sep 3, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 58d2900

Command Status Duration Result
nx run-many --targets=build --exclude=examples/... ✅ Succeeded 3s View ↗

☁️ Nx Cloud last updated this comment at 2026-09-03 10:28:39 UTC

@pkg-pr-new

pkg-pr-new Bot commented Sep 3, 2026

Copy link
Copy Markdown

Open in StackBlitz

@tanstack/ai

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

@tanstack/ai-acp

npm i https://pkg.pr.new/@tanstack/ai-acp@1316

@tanstack/ai-angular

npm i https://pkg.pr.new/@tanstack/ai-angular@1316

@tanstack/ai-anthropic

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

@tanstack/ai-bedrock

npm i https://pkg.pr.new/@tanstack/ai-bedrock@1316

@tanstack/ai-byteplus

npm i https://pkg.pr.new/@tanstack/ai-byteplus@1316

@tanstack/ai-claude-code

npm i https://pkg.pr.new/@tanstack/ai-claude-code@1316

@tanstack/ai-client

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

@tanstack/ai-cloudflare

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

@tanstack/ai-code-mode

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

@tanstack/ai-code-mode-snippets

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

@tanstack/ai-codex

npm i https://pkg.pr.new/@tanstack/ai-codex@1316

@tanstack/ai-cohere

npm i https://pkg.pr.new/@tanstack/ai-cohere@1316

@tanstack/ai-compaction

npm i https://pkg.pr.new/@tanstack/ai-compaction@1316

@tanstack/ai-devtools-core

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

@tanstack/ai-durable-stream

npm i https://pkg.pr.new/@tanstack/ai-durable-stream@1316

@tanstack/ai-elevenlabs

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

@tanstack/ai-event-client

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

@tanstack/ai-fal

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

@tanstack/ai-gemini

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

@tanstack/ai-grok

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

@tanstack/ai-grok-build

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

@tanstack/ai-groq

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

@tanstack/ai-isolate-cloudflare

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

@tanstack/ai-isolate-daytona

npm i https://pkg.pr.new/@tanstack/ai-isolate-daytona@1316

@tanstack/ai-isolate-node

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

@tanstack/ai-isolate-quickjs

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

@tanstack/ai-isolate-quickjs-bun

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

@tanstack/ai-llmgateway

npm i https://pkg.pr.new/@tanstack/ai-llmgateway@1316

@tanstack/ai-lovable

npm i https://pkg.pr.new/@tanstack/ai-lovable@1316

@tanstack/ai-mcp

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

@tanstack/ai-memory

npm i https://pkg.pr.new/@tanstack/ai-memory@1316

@tanstack/ai-mistral

npm i https://pkg.pr.new/@tanstack/ai-mistral@1316

@tanstack/ai-octane

npm i https://pkg.pr.new/@tanstack/ai-octane@1316

@tanstack/ai-ollama

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

@tanstack/ai-openai

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

@tanstack/ai-opencode

npm i https://pkg.pr.new/@tanstack/ai-opencode@1316

@tanstack/ai-openrouter

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

@tanstack/ai-perplexity

npm i https://pkg.pr.new/@tanstack/ai-perplexity@1316

@tanstack/ai-persistence

npm i https://pkg.pr.new/@tanstack/ai-persistence@1316

@tanstack/ai-preact

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

@tanstack/ai-react

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

@tanstack/ai-react-ui

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

@tanstack/ai-remix

npm i https://pkg.pr.new/@tanstack/ai-remix@1316

@tanstack/ai-sandbox

npm i https://pkg.pr.new/@tanstack/ai-sandbox@1316

@tanstack/ai-sandbox-cloudflare

npm i https://pkg.pr.new/@tanstack/ai-sandbox-cloudflare@1316

@tanstack/ai-sandbox-daytona

npm i https://pkg.pr.new/@tanstack/ai-sandbox-daytona@1316

@tanstack/ai-sandbox-docker

npm i https://pkg.pr.new/@tanstack/ai-sandbox-docker@1316

@tanstack/ai-sandbox-local-process

npm i https://pkg.pr.new/@tanstack/ai-sandbox-local-process@1316

@tanstack/ai-sandbox-sprites

npm i https://pkg.pr.new/@tanstack/ai-sandbox-sprites@1316

@tanstack/ai-sandbox-upstash-box

npm i https://pkg.pr.new/@tanstack/ai-sandbox-upstash-box@1316

@tanstack/ai-sandbox-vercel

npm i https://pkg.pr.new/@tanstack/ai-sandbox-vercel@1316

@tanstack/ai-skills

npm i https://pkg.pr.new/@tanstack/ai-skills@1316

@tanstack/ai-solid

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

@tanstack/ai-solid-ui

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

@tanstack/ai-svelte

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

@tanstack/ai-utils

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

@tanstack/ai-vercel-gateway

npm i https://pkg.pr.new/@tanstack/ai-vercel-gateway@1316

@tanstack/ai-vertex

npm i https://pkg.pr.new/@tanstack/ai-vertex@1316

@tanstack/ai-vue

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

@tanstack/ai-vue-ui

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

@tanstack/openai-base

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

@tanstack/preact-ai-devtools

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

@tanstack/react-ai-devtools

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

@tanstack/solid-ai-devtools

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

@tanstack/svelte-ai-devtools

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

commit: 58d2900

@AlemTuzlak
AlemTuzlak merged commit 78a71c8 into main Sep 3, 2026
11 checks passed
@AlemTuzlak
AlemTuzlak deleted the docs/package-readme-banners branch September 3, 2026 10:33
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