Skip to content

Commit 370c2cb

Browse files
KyleAMathewsclaudeautofix-ci[bot]
authored
Copy-edit: tighten blog post prose (#740)
* Tighten blog post prose with Strunk & White editing pass Apply rigorous copy-editing: omit needless words, strengthen verbs, use active voice, improve parallel construction, and cut flab throughout the "From Docs to Agents" post. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Second Strunk & White pass: deeper trims + fix author name Cut remaining filler articles, weak futures, redundant context phrases, and strengthened verb constructions. Fix "Matthews" → "Mathews". Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Rename init→install, Playbooks→Intents Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Restructure narrative: fix heading, move split-brain argument, flesh out intents, tighten closing - Rename "Skills as side quests" → "The copy-paste era" to match section content - Move the training-data version-mixing argument up into the intro section where it hits harder, right after the core idea - Add audience transition sentence between maintainer and consumer sections - Add concrete YAML example to "From skills to intents" section - Cut redundant lifecycle summary sentence from closing — end on the strong "correct patterns absorbed in real work" line - Fix all CLI commands to use `npx @tanstack/intent <command>` form Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * ci: apply automated fixes --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
1 parent 9b126a8 commit 370c2cb

File tree

1 file changed

+60
-48
lines changed

1 file changed

+60
-48
lines changed

src/blog/from-docs-to-agents.md

Lines changed: 60 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,44 @@
11
---
2-
title: "From Docs to Agents: Shipping Knowledge That Travels With Your Package"
2+
title: 'From Docs to Agents: Shipping Knowledge That Travels With Your Package'
33
published: 2026-03-04
44
authors:
55
- Sarah Gerrard
6-
- Kyle Matthews
6+
- Kyle Mathews
77
---
88

99
Your docs are good. Your types are solid. Your agent still gets it wrong.
1010

11-
Not because it's dumb — because there's no pipeline between what you know about your tool and what agents know about your tool. Docs are written for humans who browse. Types check individual API calls but can't encode intent. Training data is a snapshot of the ecosystem as it *was*, mixing versions without flagging which one applies. The knowledge gap between your tool and agents using your tool isn't a content problem. It's a lifecycle problem.
11+
Not because it's dumb — because nothing connects what you know about your tool to what agents know. Docs target humans who browse. Types check individual API calls but can't encode intent. Training data snapshots the ecosystem as it _was_, mixing versions without flagging which applies. The gap isn't content. It's lifecycle.
1212

13-
## Skills as side quests
13+
## The copy-paste era
1414

15-
The ecosystem is already moving toward agent-readable knowledge. Cursor rules, CLAUDE.md files, skills directories — the idea that agents need more than docs and types has landed. But the delivery mechanism hasn't caught up.
15+
The ecosystem already moves toward agent-readable knowledge. Cursor rules, CLAUDE.md files, skills directories — everyone agrees agents need more than docs and types. But delivery hasn't caught up.
1616

17-
Right now, if you want your agent to understand TanStack Router, you go find a community-maintained rules file in some GitHub repo. Maybe it's in `awesome-cursorrules`. Maybe someone linked it in Discord. You copy it into your project's `.cursorrules` or `CLAUDE.md`. Then you do the same for TanStack Query. And TanStack Table. Each one sourced from a different place, written by a different person, at a different point in time.
17+
Right now, if you want your agent to understand TanStack Router, you hunt for a community-maintained rules file in some GitHub repo. Maybe it's in `awesome-cursorrules`. Maybe someone linked it in Discord. You copy it into `.cursorrules` or `CLAUDE.md`. Then you repeat for TanStack Query. And TanStack Table. Each from a different place, a different author, a different point in time.
1818

19-
Now multiply that across every tool in your stack. You're managing a pile of copy-pasted knowledge files with no versioning, no update mechanism, and no way to know when they've gone stale. Did TanStack Router ship a breaking change last week? Your rules file doesn't know. Is the Query skill you grabbed written for v4 or v5? Hope you checked.
19+
Multiply that across every tool in your stack. You're managing copy-pasted knowledge files with no versioning, no update path, and no staleness signal. Did TanStack Router ship a breaking change last week? Your rules file doesn't know. Is the Query skill you grabbed written for v4 or v5? Hope you checked.
2020

21-
Finding skills is manual. Installing them is manual. Keeping them current is manual. And when they drift — and they always drift — you don't find out until your agent starts producing subtly wrong code again.
21+
Finding skills is manual. Installing them is manual. Keeping them current is manual. When they drift — and they always drift — you discover it only when your agent starts producing subtly wrong code.
2222

23-
Meanwhile, library maintainers already have the knowledge agents need. It lives in their docs, migration guides, "common mistakes" GitHub discussions, Discord answers. But none of it reaches agents through a channel the maintainer controls. The knowledge exists. What's missing is a delivery mechanism tied to the package itself — not scattered across the ecosystem.
23+
Library maintainers already have the knowledge agents needin docs, migration guides, "common mistakes" GitHub discussions, Discord answers. But none of it reaches agents through a channel the maintainer controls. The knowledge exists. The delivery mechanism doesn't.
2424

2525
![The status quo: scattered rules files from different repos, authors, and versions, all manually copy-pasted into one project](/blog-assets/from-docs-to-agents/diagram-status-quo.svg)
2626

2727
## Introducing `@tanstack/intent`
2828

29-
`@tanstack/intent` is the missing lifecycle layer. It's a toolkit for generating, discovering, and maintaining skills for your library — and shipping them as npm packages so they travel with your code.
29+
`@tanstack/intent` is the missing lifecycle layer a toolkit for generating, discovering, and maintaining skills, shipped as npm packages that travel with your code.
3030

3131
```bash
3232
pnpm add -D @tanstack/intent
3333
```
3434

35-
The core idea: **intents are npm packages of skills.** They encode how tools work together, what patterns apply for which goals, and what to avoid. Skills travel with the tool via `npm update`, not the model's training cutoff. Not community-maintained rules files in separate repos. Not prompt snippets in READMEs. Versioned knowledge the maintainer owns, shipped through npm, updated when the package updates.
35+
The core idea: **intents are npm packages of skills.** They encode how tools compose, which patterns fit which goals, and what to avoid. Skills travel with the tool via `npm update`not the model's training cutoff, not community-maintained rules files, not prompt snippets in READMEs. Versioned knowledge the maintainer owns, updated when the package updates.
3636

37-
A skill is a focused projection of knowledge you already maintain — the critical constraint an agent must know, the anti-pattern flagged explicitly, the composition rule stated once and clearly. Each skill declares which docs it was derived from:
37+
This matters because the alternative — hoping model providers re-train on your latest docs — is not a strategy. Training data has a permanent version-mixing problem: once a breaking change ships, models contain _both_ versions forever with no way to disambiguate. Skills bypass this. They're versioned with your package, and `npm update` brings the latest knowledge with the latest code.
38+
39+
![Model training data mixes versions permanently vs. skills pinned to your installed version](./diagram-split-brain.svg)
40+
41+
A skill is a focused projection of knowledge you already maintain: the critical constraint, the flagged anti-pattern, the composition rule stated once and clearly. Each declares its source docs:
3842

3943
```
4044
---
@@ -50,92 +54,100 @@ metadata:
5054
---
5155
```
5256

53-
That `metadata.sources` field is load-bearing. When those docs change, the CLI flags the skill for review. You're not maintaining two sources of truth — you're maintaining one, with a derived artifact that stays in sync.
57+
That `metadata.sources` field is load-bearing. When those docs change, the CLI flags the skill for review. One source of truth, one derived artifact that stays in sync.
5458

5559
## Generating and validating skills
5660

57-
You don't author skills from scratch. `intent scaffold` walks you through a guided workflow to generate skills for your library:
61+
You don't author skills from scratch. `@tanstack/intent scaffold` generates them from your library:
5862

5963
```bash
60-
npx intent scaffold
64+
npx @tanstack/intent scaffold
6165
```
6266

63-
The scaffold produces drafts you review, refine, and commit alongside your source code. Once you have skills, `intent validate` checks that your skill files are well-formed:
67+
The scaffold produces drafts you review, refine, and commit. Once committed, `@tanstack/intent validate` checks that they're well-formed:
6468

6569
```bash
66-
npx intent validate
70+
npx @tanstack/intent validate
6771
```
6872

69-
And `intent setup` copies CI workflow templates into your repo so validation runs automatically on every push:
73+
`@tanstack/intent setup` copies CI workflow templates into your repo so validation runs on every push:
7074

7175
```bash
72-
npx intent setup
76+
npx @tanstack/intent setup
7377
```
7478

75-
This matters because the alternative is hoping model providers eventually re-train on your latest docs. That's not a strategy. Training data has a permanent version-mixing problem: once a breaking change ships, models contain *both* versions forever with no mechanism to disambiguate. Skills bypass this entirely. They're versioned with your package, and `npm update` brings the latest knowledge with the latest code.
76-
77-
![Model training data mixes versions permanently vs. skills pinned to your installed version](./diagram-split-brain.svg)
78-
7979
## The dependency graph does the discovery
8080

81-
When a developer runs `intent init`, the CLI discovers every intent-enabled package in their project and wires the relevant skills into their agent configuration — CLAUDE.md, .cursorrules, whatever their tooling expects.
81+
That's the maintainer side. For developers using those libraries, the experience is simpler.
82+
83+
When a developer runs `@tanstack/intent install`, the CLI discovers every intent-enabled package and wires skills into the agent configuration — CLAUDE.md, .cursorrules, whatever the tooling expects.
8284

8385
```bash
84-
npx intent init
86+
npx @tanstack/intent install
8587
```
8688

87-
![intent init discovers intent-enabled packages in node_modules and wires skills into agent config](./diagram-discovery.svg)
89+
![intent install discovers intent-enabled packages in node_modules and wires skills into agent config](./diagram-discovery.svg)
8890

89-
No manual setup per-library. No hunting for rules files. Install the package, run `intent init`, and the agent understands the tool. Update the package, and the skills update with it. Knowledge travels through the same channel as code.
91+
No per-library setup. No hunting for rules files. Install the package, run `@tanstack/intent install`, and the agent understands the tool. Update the package, and skills update too. Knowledge travels the same channel as code.
9092

91-
`intent list` shows you what's available:
93+
`@tanstack/intent list` shows you what's available:
9294

9395
```bash
94-
npx intent list # See what's intent-enabled in your deps
95-
npx intent list --json # Machine-readable output
96+
npx @tanstack/intent list # See what's intent-enabled in your deps
97+
npx @tanstack/intent list --json # Machine-readable output
9698
```
9799

98-
For library maintainers, `intent meta` surfaces meta-skills — higher-level guidance for how to author and maintain skills for your library:
100+
For library maintainers, `@tanstack/intent meta` surfaces meta-skills — higher-level guidance on authoring and maintaining skills:
99101

100102
```bash
101-
npx intent meta
103+
npx @tanstack/intent meta
102104
```
103105

104-
## From skills to playbooks
106+
## From skills to intents
105107

106-
A single skill helps an agent use one tool correctly. But real development is composition — routing *with* server state *with* a data grid *with* client-side storage. No individual skill covers how they fit together.
108+
A single skill helps an agent use one tool correctly. Real development demands composition — routing _with_ server state _with_ a data grid _with_ client-side storage. No single skill covers how they fit together.
107109

108-
Playbooks are the orchestration layer. A developer says "build a paginated data table with URL-synced filters" and the playbook knows which skills to load and how they compose — the search params skill, the loader/query integration skill, the table columnDefs skill, in the right order. Developer goals map to skill combinations.
110+
Intents are the orchestration layer. A developer says "build a paginated data table with URL-synced filters" and the intent loads the right skills in the right order:
109111

110-
The more libraries in your stack that ship skills, the richer the composition story becomes.
112+
```
113+
---
114+
name: paginated-data-table
115+
description: URL-synced paginated data table with TanStack Router, Query, and Table
116+
skills:
117+
- tanstack-router-search-params
118+
- tanstack-query-loader-integration
119+
- tanstack-table-column-defs
120+
- tanstack-table-pagination
121+
---
122+
```
123+
124+
Developer goals map to skill combinations. The more libraries in your stack that ship skills, the richer composition becomes.
111125

112126
## Keeping it current
113127

114-
The real risk with any derived artifact is staleness. You update your docs, ship a new API, and the skills silently drift. `@tanstack/intent` treats this as a first-class problem.
128+
The real risk with any derived artifact is staleness. You update your docs, ship a new API, and skills silently drift. `@tanstack/intent` treats staleness as a first-class problem.
115129

116-
`intent stale` checks your skills for version driftflagging any that may have fallen behind their source material:
130+
`@tanstack/intent stale` checks for version drift, flagging skills that have fallen behind their sources:
117131

118132
```bash
119-
npx intent stale # Human-readable report
120-
npx intent stale --json # Machine-readable for CI
133+
npx @tanstack/intent stale # Human-readable report
134+
npx @tanstack/intent stale --json # Machine-readable for CI
121135
```
122136

123-
Run it in CI and you get a failing check when source material has changed. The skill becomes part of your release checklist — not something you remember to update, something your pipeline catches.
137+
Run it in CI and you get a failing check when sources change. Skills become part of your release checklist — not something you remember to update, but something your pipeline catches.
124138

125139
![The intent lifecycle: docs to skills to npm to agent config, with staleness checks and feedback loops](./diagram-lifecycle.svg)
126140

127-
The feedback loop runs both directions. `intent feedback` lets users submit structured reports when a skill produces incorrect output — which skill was active, which version, what went wrong. That context flows back to you as a maintainer, and the fix ships to everyone on the next `npm update`.
141+
The feedback loop runs both directions. `@tanstack/intent feedback` lets users submit structured reports when a skill produces wrong output — which skill, which version, what broke. That context flows back to you, and the fix ships to everyone on the next `npm update`.
128142

129143
```bash
130-
npx intent feedback
144+
npx @tanstack/intent feedback
131145
```
132146

133-
Skills that keep needing the same workaround are a signal. Sometimes the fix is a better skill. Sometimes it's a better API. A skill that dissolves because the tool absorbed its lesson is the system working as intended.
147+
Skills that keep needing the same workaround signal a deeper problem. Sometimes the fix is a better skill. Sometimes it's a better API. A skill that dissolves because the tool absorbed its lesson is the system working.
134148

135149
## The new job
136150

137-
Devtool makers have a new surface to maintain. You used to ship code, docs, and types. Now there's a fourth artifact: skills — knowledge encoded for the thing writing most of the code.
138-
139-
The tools that invest here will produce developers who build confidently with them from day one. Not through tutorials. Not through toy projects. Through correct patterns absorbed in the context of their own real work.
151+
Devtool makers have a new surface to maintain. You shipped code, docs, and types. Now there's a fourth artifact: skills — knowledge encoded for the thing writing most of your code.
140152

141-
The lifecycle is: write your docs, generate skills, ship them with your package, validate and keep them current, learn from how they're used, make your tool better. Repeat.
153+
Tools that invest here produce developers who build confidently from day one — not through tutorials or toy projects, but through correct patterns absorbed in real work.

0 commit comments

Comments
 (0)