docs: add TanStack AI banner to package READMEs - #1316
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (39)
Included review availability: Your plan provides up to 8 included reviews per hour; 7 remain after this review. 📝 WalkthroughWalkthroughThe 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. ChangesREADME banner standardization
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This change standardizes package README banners and contributor guidance without modifying runtime behavior. No current merge-blocking risk remains. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Description checkExplanation 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 CoverageExplanation 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)
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. Comment |
|
View your CI Pipeline Execution ↗ for commit 58d2900
☁️ Nx Cloud last updated this comment at |
@tanstack/ai
@tanstack/ai-acp
@tanstack/ai-angular
@tanstack/ai-anthropic
@tanstack/ai-bedrock
@tanstack/ai-byteplus
@tanstack/ai-claude-code
@tanstack/ai-client
@tanstack/ai-cloudflare
@tanstack/ai-code-mode
@tanstack/ai-code-mode-snippets
@tanstack/ai-codex
@tanstack/ai-cohere
@tanstack/ai-compaction
@tanstack/ai-devtools-core
@tanstack/ai-durable-stream
@tanstack/ai-elevenlabs
@tanstack/ai-event-client
@tanstack/ai-fal
@tanstack/ai-gemini
@tanstack/ai-grok
@tanstack/ai-grok-build
@tanstack/ai-groq
@tanstack/ai-isolate-cloudflare
@tanstack/ai-isolate-daytona
@tanstack/ai-isolate-node
@tanstack/ai-isolate-quickjs
@tanstack/ai-isolate-quickjs-bun
@tanstack/ai-llmgateway
@tanstack/ai-lovable
@tanstack/ai-mcp
@tanstack/ai-memory
@tanstack/ai-mistral
@tanstack/ai-octane
@tanstack/ai-ollama
@tanstack/ai-openai
@tanstack/ai-opencode
@tanstack/ai-openrouter
@tanstack/ai-perplexity
@tanstack/ai-persistence
@tanstack/ai-preact
@tanstack/ai-react
@tanstack/ai-react-ui
@tanstack/ai-remix
@tanstack/ai-sandbox
@tanstack/ai-sandbox-cloudflare
@tanstack/ai-sandbox-daytona
@tanstack/ai-sandbox-docker
@tanstack/ai-sandbox-local-process
@tanstack/ai-sandbox-sprites
@tanstack/ai-sandbox-upstash-box
@tanstack/ai-sandbox-vercel
@tanstack/ai-skills
@tanstack/ai-solid
@tanstack/ai-solid-ui
@tanstack/ai-svelte
@tanstack/ai-utils
@tanstack/ai-vercel-gateway
@tanstack/ai-vertex
@tanstack/ai-vue
@tanstack/ai-vue-ui
@tanstack/openai-base
@tanstack/preact-ai-devtools
@tanstack/react-ai-devtools
@tanstack/solid-ai-devtools
@tanstack/svelte-ai-devtools
commit: |
npm package pages for 36 adapters now show the TanStack AI banner. New
packages/*/README.mdfiles must start with that same<picture>block.🎯 Changes
https://tanstack.com/api/readme/ai.pngbanner to 35 package READMEs that had none.media/header_ai.pngimage on@tanstack/ai-coherewith the same<picture>banner.AGENTS.md,CLAUDE.md, andCONTRIBUTING.mdwhen 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
pnpm run test:pr, or these tests do not apply to this pull request.docs/for this change, or this change is not user-facing.pnpm changeset), or this PR does not change a published package.🚀 Release Impact
Testing
pnpm exec oxfmton the 39 changed files: pass.pnpm test:docs: fail on untracked leftover files underdocs/superpowers/worktrees/, not on these READMEs.pnpm test:prskipped: markdown and agent-instruction files only.packages/ai-cloudflare/README.md.<picture>banner withtanstack.com/api/readme/ai.png.packages/ai-cohere/README.mdand confirmheader_ai.pngis gone.AGENTS.mdforPackage README banner.packages/ai/README.md. Reviewer can greptanstack.com/api/readme/ai.pngvsheader_ai.png.Risk / rollback
Low. README and agent-instruction text only. Revert the PR to undo.
Summary by CodeRabbit