Skip to content

Commit c89ffba

Browse files
committed
docs: update READMEs, docs, and homepage for new skill structure
Remove references to old granular skills (core, cli, scopes-and-context, sessions-and-tags, testing) and replace with the two-skill setup: agentcrumbs (top-level) and agentcrumbs/init.
1 parent 62abf24 commit c89ffba

File tree

4 files changed

+15
-31
lines changed

4 files changed

+15
-31
lines changed

README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,8 @@ agentcrumbs ships with [@tanstack/intent](https://tanstack.com/blog/from-docs-to
2929

3030
| Skill | What it teaches |
3131
| --- | --- |
32+
| `agentcrumbs` | Core workflow, API, markers, CLI reference, common mistakes |
3233
| `agentcrumbs/init` | Scans repo, discovers namespaces, writes config |
33-
| `agentcrumbs/core` | `trail()`, `crumb()`, markers, env var, noop guarantee |
34-
| `agentcrumbs/scopes-and-context` | `scope()`, `wrap()`, `child()`, `snapshot()`, `assert()` |
35-
| `agentcrumbs/sessions-and-tags` | `session()`, tags, grouping and filtering |
36-
| `agentcrumbs/cli` | `collect`, `tail`, `query`, `strip`, `session` |
3734

3835
Skills travel with the package version. The agent always has docs matching the installed code.
3936

docs/content/docs/skills.mdx

Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -30,43 +30,34 @@ Each skill is a Markdown file with YAML frontmatter:
3030

3131
```yaml
3232
---
33-
name: agentcrumbs/core
33+
name: agentcrumbs
3434
description: >
35-
Core debug tracing with agentcrumbs: trail(), crumb(),
36-
@crumbs markers, env var config, noop strategy...
35+
Debug mode for AI coding agents. Drop structured traces inline
36+
while writing code, query them when something breaks, strip
37+
before merge.
3738
type: core
3839
library: agentcrumbs
39-
library_version: "0.1.0"
40+
library_version: "0.2.0"
4041
sources:
42+
- "triggerdotdev/agentcrumbs:README.md"
4143
- "triggerdotdev/agentcrumbs:src/trail.ts"
42-
- "triggerdotdev/agentcrumbs:src/env.ts"
4344
---
4445
```
4546

46-
The content includes correct usage patterns, explicitly flags common mistakes, and defines constraints the agent must follow.
47+
The content includes correct usage patterns, explicitly flags common mistakes, and points agents to CLI help and docs for deeper discovery.
4748

4849
## Available skills
4950

5051
| Skill | What it teaches |
5152
| --- | --- |
53+
| `agentcrumbs` | Core workflow, API, markers, CLI quick reference, critical mistakes, and pointers to further discovery |
5254
| `agentcrumbs/init` | Scans repo structure, discovers namespaces, writes config to CLAUDE.md or .cursorrules |
53-
| `agentcrumbs/core` | `trail()`, `crumb()`, `// @crumbs` markers, `#region @crumbs` blocks, env var, noop guarantee |
54-
| `agentcrumbs/scopes-and-context` | `scope()`, `wrap()`, `child()`, `snapshot()`, `assert()`, context propagation |
55-
| `agentcrumbs/sessions-and-tags` | `session()`, tags, grouping crumbs for replay and filtering |
5655

57-
| `agentcrumbs/cli` | `collect`, `tail`, `query`, `strip`, `session`, and other CLI commands |
58-
59-
## What each skill contains
60-
61-
**Patterns.** Correct usage examples the agent can copy. These show the right way to use each API, with proper markers, at module scope, with structured data.
62-
63-
**Common mistakes.** Explicitly marked with severity levels (CRITICAL, HIGH, MEDIUM). Things like: checking `process.env.AGENTCRUMBS` on every call instead of using the noop, creating `trail()` inside request handlers, forgetting `// @crumbs` markers. The agent learns what to avoid, not just what to do.
64-
65-
**Constraints.** Hard rules: every crumb line must have a marker, don't invent namespaces without checking the catalog, create trails at module scope.
56+
The top-level `agentcrumbs` skill covers the essentials an agent needs to use crumbs correctly: the write-collect-query-strip workflow, core API (`trail`, `crumb`, `child`, `scope`), marker syntax, and the most common mistakes. For deeper functionality like sessions, tags, scopes, and testing patterns, it points agents to CLI help (`agentcrumbs --help`), type definitions, and the docs.
6657

6758
## The init skill
6859

69-
The `agentcrumbs/init` skill deserves special mention. It's the entry point for setting up agentcrumbs in any project.
60+
The `agentcrumbs/init` skill is the entry point for setting up agentcrumbs in any project.
7061

7162
When the agent runs init, it:
7263

@@ -81,9 +72,8 @@ After init, every agent working in the repo uses the same consistent namespaces.
8172
If you don't use @tanstack/intent, you can point agents to skills directly:
8273

8374
```
84-
skills/agentcrumbs/core/SKILL.md
85-
skills/agentcrumbs/cli/SKILL.md
86-
skills/agentcrumbs/init/SKILL.md
75+
node_modules/agentcrumbs/skills/agentcrumbs/SKILL.md
76+
node_modules/agentcrumbs/skills/agentcrumbs/init/SKILL.md
8777
```
8878

8979
Or add a reference in your agent config file manually. But `npx @tanstack/intent install` handles all of this automatically.

docs/src/app/page.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,7 @@ export default function HomePage() {
248248
</div>
249249

250250
<div className="hp-skills-detail">
251-
<p>agentcrumbs ships 5 skills via <a href="https://tanstack.com/blog/from-docs-to-agents" target="_blank">@tanstack/intent</a>, covering the full API, CLI, and common mistakes. Skills travel with the package version, so the agent always has docs matching the installed code.</p>
251+
<p>agentcrumbs ships 2 skills via <a href="https://tanstack.com/blog/from-docs-to-agents" target="_blank">@tanstack/intent</a>: one covering the core workflow, API, and common mistakes, and an init skill that sets up your repo. Skills travel with the package version, so the agent always has docs matching the installed code.</p>
252252
<p>Compatible with Claude Code, Cursor, GitHub Copilot, and any agent that supports the <a href="https://agentskills.io" target="_blank">Agent Skills spec</a>.</p>
253253
</div>
254254
</div>

packages/agentcrumbs/README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,8 @@ agentcrumbs ships with [@tanstack/intent](https://tanstack.com/blog/from-docs-to
2929

3030
| Skill | What it teaches |
3131
| --- | --- |
32+
| `agentcrumbs` | Core workflow, API, markers, CLI reference, common mistakes |
3233
| `agentcrumbs/init` | Scans repo, discovers namespaces, writes config |
33-
| `agentcrumbs/core` | `trail()`, `crumb()`, markers, env var, noop guarantee |
34-
| `agentcrumbs/scopes-and-context` | `scope()`, `wrap()`, `child()`, `snapshot()`, `assert()` |
35-
| `agentcrumbs/sessions-and-tags` | `session()`, tags, grouping and filtering |
36-
| `agentcrumbs/cli` | `collect`, `tail`, `query`, `strip`, `session` |
3734

3835
Skills travel with the package version. The agent always has docs matching the installed code.
3936

0 commit comments

Comments
 (0)