docs: add agent-skills guide and SEO frontmatter#464
Merged
AlemTuzlak merged 1 commit intomainfrom Apr 17, 2026
Merged
Conversation
Add a new getting-started/agent-skills.md guide explaining how to use @tanstack/intent install to wire the bundled Agent Skills from @tanstack/ai and @tanstack/ai-code-mode into Claude Code, Cursor, GitHub Copilot, and other AI coding assistants, register it in docs/config.json, and add a disambiguation callout on code-mode-with-skills.md so readers searching for "skills" land on the correct page. Add description and keywords frontmatter to all 64 hand-authored docs for search-engine discoverability. Auto-generated TypeDoc reference pages under docs/reference/ are left untouched since they would be overwritten on the next regeneration. A follow-up PR on tanstack.com will wire these fields into the document head.
Contributor
📝 WalkthroughWalkthroughThis pull request adds frontmatter metadata (description and keywords fields) to approximately 50 documentation files across multiple sections of the docs, improving discoverability and SEO. Additionally, a new "Agent Skills (TanStack Intent)" documentation page is introduced, along with a navigation config update and a clarifying note about Code Mode skills. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~20 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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 |
Contributor
🚀 Changeset Version Preview6 package(s) bumped directly, 22 bumped as dependents. 🟩 Patch bumps
|
|
View your CI Pipeline Execution ↗ for commit 6bca67d
☁️ Nx Cloud last updated this comment at |
@tanstack/ai
@tanstack/ai-anthropic
@tanstack/ai-client
@tanstack/ai-code-mode
@tanstack/ai-code-mode-skills
@tanstack/ai-devtools-core
@tanstack/ai-elevenlabs
@tanstack/ai-event-client
@tanstack/ai-fal
@tanstack/ai-gemini
@tanstack/ai-grok
@tanstack/ai-groq
@tanstack/ai-isolate-cloudflare
@tanstack/ai-isolate-node
@tanstack/ai-isolate-quickjs
@tanstack/ai-ollama
@tanstack/ai-openai
@tanstack/ai-openrouter
@tanstack/ai-preact
@tanstack/ai-react
@tanstack/ai-react-ui
@tanstack/ai-solid
@tanstack/ai-solid-ui
@tanstack/ai-svelte
@tanstack/ai-vue
@tanstack/ai-vue-ui
@tanstack/preact-ai-devtools
@tanstack/react-ai-devtools
@tanstack/solid-ai-devtools
commit: |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/community-adapters/guide.md (1)
1-217:⚠️ Potential issue | 🟡 MinorFix GitHub URL casing inconsistencies.
Two GitHub URLs use lowercase
tanstack/aiwhile the canonical organization name and five other references useTanStack/ai. Update these to match:
- Line ~55:
https://github.com/tanstack/ai/tree/main/packages/typescript→https://github.com/TanStack/ai/tree/main/packages/typescript- Line ~57:
https://github.com/tanstack/ai/tree/main/packages/typescript/ai-openai→https://github.com/TanStack/ai/tree/main/packages/typescript/ai-openai🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/community-adapters/guide.md` around lines 1 - 217, Two GitHub links use the wrong casing; replace the lowercase URLs `https://github.com/tanstack/ai/tree/main/packages/typescript` and `https://github.com/tanstack/ai/tree/main/packages/typescript/ai-openai` with the canonical-casing versions `https://github.com/TanStack/ai/tree/main/packages/typescript` and `https://github.com/TanStack/ai/tree/main/packages/typescript/ai-openai` respectively so all repository links match the other `TanStack/ai` references in the document.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/getting-started/agent-skills.md`:
- Line 24: Change the phrase "markdown documents" to "Markdown documents" in the
Agent Skills description (the sentence referencing SKILL.md and Agent Skills) so
the term Markdown is capitalized consistently; update the text that reads "Agent
Skills are markdown documents (`SKILL.md`)..." to "Agent Skills are Markdown
documents (`SKILL.md`)..." in the same paragraph.
---
Outside diff comments:
In `@docs/community-adapters/guide.md`:
- Around line 1-217: Two GitHub links use the wrong casing; replace the
lowercase URLs `https://github.com/tanstack/ai/tree/main/packages/typescript`
and `https://github.com/tanstack/ai/tree/main/packages/typescript/ai-openai`
with the canonical-casing versions
`https://github.com/TanStack/ai/tree/main/packages/typescript` and
`https://github.com/TanStack/ai/tree/main/packages/typescript/ai-openai`
respectively so all repository links match the other `TanStack/ai` references in
the document.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 803f442e-721d-43f8-8d72-32a42121dac1
📒 Files selected for processing (65)
docs/adapters/anthropic.mddocs/adapters/elevenlabs.mddocs/adapters/fal.mddocs/adapters/gemini.mddocs/adapters/grok.mddocs/adapters/groq.mddocs/adapters/ollama.mddocs/adapters/openai.mddocs/adapters/openrouter.mddocs/advanced/extend-adapter.mddocs/advanced/middleware.mddocs/advanced/multimodal-content.mddocs/advanced/observability.mddocs/advanced/per-model-type-safety.mddocs/advanced/runtime-adapter-switching.mddocs/advanced/tree-shaking.mddocs/api/ai-client.mddocs/api/ai-preact.mddocs/api/ai-react.mddocs/api/ai-solid.mddocs/api/ai-svelte.mddocs/api/ai-vue.mddocs/api/ai.mddocs/architecture/approval-flow-processing.mddocs/chat/agentic-cycle.mddocs/chat/connection-adapters.mddocs/chat/streaming.mddocs/chat/structured-outputs.mddocs/chat/thinking-content.mddocs/code-mode/client-integration.mddocs/code-mode/code-mode-isolates.mddocs/code-mode/code-mode-with-skills.mddocs/code-mode/code-mode.mddocs/community-adapters/cencori.mddocs/community-adapters/cloudflare.mddocs/community-adapters/decart.mddocs/community-adapters/guide.mddocs/community-adapters/mynth.mddocs/community-adapters/soniox.mddocs/comparison/vercel-ai-sdk.mddocs/config.jsondocs/getting-started/agent-skills.mddocs/getting-started/devtools.mddocs/getting-started/overview.mddocs/getting-started/quick-start-server.mddocs/getting-started/quick-start-svelte.mddocs/getting-started/quick-start-vue.mddocs/getting-started/quick-start.mddocs/media/generation-hooks.mddocs/media/generations.mddocs/media/image-generation.mddocs/media/realtime-chat.mddocs/media/text-to-speech.mddocs/media/transcription.mddocs/media/video-generation.mddocs/migration/migration.mddocs/protocol/chunk-definitions.mddocs/protocol/http-stream-protocol.mddocs/protocol/sse-protocol.mddocs/tools/client-tools.mddocs/tools/lazy-tool-discovery.mddocs/tools/server-tools.mddocs/tools/tool-approval.mddocs/tools/tool-architecture.mddocs/tools/tools.md
|
|
||
| ## What are Agent Skills? | ||
|
|
||
| Agent Skills are markdown documents (`SKILL.md`) that ship inside npm packages and tell AI coding agents how to use a library correctly — which functions to use, which patterns to avoid, and when to reach for which module. The format is an open standard supported by Claude Code, Cursor, GitHub Copilot, Codex, and others. |
Contributor
There was a problem hiding this comment.
Capitalize “Markdown” for terminology consistency.
Line 24 should use “Markdown documents” (proper noun) instead of “markdown documents”.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~24-~24: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...hat are Agent Skills? Agent Skills are markdown documents (SKILL.md) that ship inside...
(MARKDOWN_NNP)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/getting-started/agent-skills.md` at line 24, Change the phrase "markdown
documents" to "Markdown documents" in the Agent Skills description (the sentence
referencing SKILL.md and Agent Skills) so the term Markdown is capitalized
consistently; update the text that reads "Agent Skills are markdown documents
(`SKILL.md`)..." to "Agent Skills are Markdown documents (`SKILL.md`)..." in the
same paragraph.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
npx @tanstack/intent@latest installto wire the Agent Skills bundled in@tanstack/aiand@tanstack/ai-code-modeinto Claude Code, Cursor, GitHub Copilot, and other AI coding assistants. Registered indocs/config.json.docs/code-mode/code-mode-with-skills.mdso readers who land there looking for agent-authoring skills (vs. runtime Code Mode skills) are routed to the new guide.descriptionandkeywordsfrontmatter to all 64 hand-authored docs for search-engine discoverability. Auto-generated TypeDoc reference pages underdocs/reference/are deliberately untouched — they would be overwritten on the next regeneration.Companion PR: TanStack/tanstack.com#834 wires the new
description/keywordsfrontmatter into<meta name="description">and<meta name="keywords">. Until that lands, the extra YAML here is harmless no-op metadata.Test plan
getting-started/agent-skills.mdpage on the docs siteAgent Skills (TanStack Intent)entry shows up under Getting Started in the sidebarCode Mode with Skillslinks correctly<meta name="description">and<meta name="keywords">reflect the frontmatter on a sample page