Skip to content

Commit 78841cd

Browse files
KyleAMathewsclaude
andcommitted
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>
1 parent 9b126a8 commit 78841cd

File tree

1 file changed

+26
-26
lines changed

1 file changed

+26
-26
lines changed

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

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,33 @@ authors:
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 no pipeline 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 one applies. The gap isn't content. It's lifecycle.
1212

1313
## Skills as side quests
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 — the idea that agents need more than docs and types has landed. But the delivery mechanism 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 your project's `.cursorrules` or `CLAUDE.md`. Then you repeat for TanStack Query. And TanStack Table. Each sourced from a different place, written by a different person, at 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 a pile of copy-pasted knowledge files with no versioning, no update mechanism, 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. What's missing is a delivery mechanism tied to the package itself.
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 for your library, 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 apply to 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, shipped through npm, updated when the package updates.
3636

37-
A skill is a focused projection of knowledge you already maintainthe 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+
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 skill declares its source docs:
3838

3939
```
4040
---
@@ -50,43 +50,43 @@ metadata:
5050
---
5151
```
5252

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.
53+
That `metadata.sources` field is load-bearing. When those docs change, the CLI flags the skill for review. You maintain one source of truth, with a derived artifact that stays in sync.
5454

5555
## Generating and validating skills
5656

57-
You don't author skills from scratch. `intent scaffold` walks you through a guided workflow to generate skills for your library:
57+
You don't author skills from scratch. `intent scaffold` guides you through generating skills for your library:
5858

5959
```bash
6060
npx intent scaffold
6161
```
6262

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:
63+
The scaffold produces drafts you review, refine, and commit alongside your source. Once you have skills, `intent validate` checks that they're well-formed:
6464

6565
```bash
6666
npx intent validate
6767
```
6868

69-
And `intent setup` copies CI workflow templates into your repo so validation runs automatically on every push:
69+
`intent setup` copies CI workflow templates into your repo so validation runs on every push:
7070

7171
```bash
7272
npx intent setup
7373
```
7474

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.
75+
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 entirely. They're versioned with your package, and `npm update` brings the latest knowledge with the latest code.
7676

7777
![Model training data mixes versions permanently vs. skills pinned to your installed version](./diagram-split-brain.svg)
7878

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+
When a developer runs `intent init`, the CLI discovers every intent-enabled package in the project and wires skills into the agent configuration — CLAUDE.md, .cursorrules, whatever the tooling expects.
8282

8383
```bash
8484
npx intent init
8585
```
8686

8787
![intent init discovers intent-enabled packages in node_modules and wires skills into agent config](./diagram-discovery.svg)
8888

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.
89+
No per-library setup. No hunting for rules files. Install the package, run `intent init`, and the agent understands the tool. Update the package, and the skills update too. Knowledge travels through the same channel as code.
9090

9191
`intent list` shows you what's available:
9292

@@ -95,47 +95,47 @@ npx intent list # See what's intent-enabled in your deps
9595
npx intent list --json # Machine-readable output
9696
```
9797

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

100100
```bash
101101
npx intent meta
102102
```
103103

104104
## From skills to playbooks
105105

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.
106+
A single skill helps an agent use one tool correctly. But real development demands composition — routing *with* server state *with* a data grid *with* client-side storage. No individual skill covers how they fit together.
107107

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.
108+
Playbooks are the orchestration layer. A developer says "build a paginated data table with URL-synced filters" and the playbook loads the right skills in the right order — search params, loader/query integration, table columnDefs. Developer goals map to skill combinations.
109109

110110
The more libraries in your stack that ship skills, the richer the composition story becomes.
111111

112112
## Keeping it current
113113

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.
114+
The real risk with any derived artifact is staleness. You update your docs, ship a new API, and skills silently drift. `@tanstack/intent` treats this as a first-class problem.
115115

116-
`intent stale` checks your skills for version driftflagging any that may have fallen behind their source material:
116+
`intent stale` checks skills for version drift, flagging any that have fallen behind their source material:
117117

118118
```bash
119119
npx intent stale # Human-readable report
120120
npx intent stale --json # Machine-readable for CI
121121
```
122122

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.
123+
Run it in CI and you get a failing check when source material changes. The skill becomes part of your release checklist — not something you remember to update, but something your pipeline catches.
124124

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

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`.
127+
The feedback loop runs both directions. `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 as a maintainer, and the fix ships to everyone on the next `npm update`.
128128

129129
```bash
130130
npx intent feedback
131131
```
132132

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.
133+
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 as designed.
134134

135135
## The new job
136136

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.
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 your code.
138138

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.
139+
Tools that invest here will produce developers who build confidently from day one — not through tutorials or toy projects, but through correct patterns absorbed in the context of real work.
140140

141141
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.

0 commit comments

Comments
 (0)