From 94bfbfa22521a898008e9109f1064e39a2e07ebb Mon Sep 17 00:00:00 2001 From: ladybluenotes Date: Sat, 5 Sep 2026 18:25:20 -0700 Subject: [PATCH 1/6] docs: clarify the maintainer release workflow --- docs/cli/intent-install.md | 13 +- docs/cli/intent-list.md | 11 +- docs/cli/intent-review.md | 211 ++++++++++ docs/cli/intent-scaffold.md | 94 +++-- docs/cli/intent-setup.md | 125 +++--- docs/cli/intent-stale.md | 266 +++++++------ docs/config.json | 4 + .../quick-start-maintainers.md | 365 +++++++----------- docs/overview.md | 200 +++++----- docs/registry.md | 43 ++- 10 files changed, 787 insertions(+), 545 deletions(-) create mode 100644 docs/cli/intent-review.md diff --git a/docs/cli/intent-install.md b/docs/cli/intent-install.md index 91fcc85c..8a45d1db 100644 --- a/docs/cli/intent-install.md +++ b/docs/cli/intent-install.md @@ -6,7 +6,7 @@ id: intent-install `intent install` confirms skill-source permissions on first use, then creates or updates an `intent-skills` guidance block in a project guidance file. ```bash -npx @tanstack/intent@latest install [--map] [--dry-run] [--print-prompt] [--global] [--global-only] [--no-notices] +npx @tanstack/intent@latest install [--maintainer] [--review] [--map] [--dry-run] [--print-prompt] [--global] [--global-only] [--no-notices] ``` ## Options @@ -29,6 +29,15 @@ npx @tanstack/intent@latest install [--map] [--dry-run] [--print-prompt] [--glob ## Behavior +### Maintainer workflow + +`install --maintainer` enables initial skill batches and source-aware skill maintenance in repository agent instructions. It works without an interactive terminal or existing consumer permissions. It writes a separate `intent-maintainer` block, preserves consumer guidance, and is idempotent. `--dry-run` previews the block. + +Run it from the library root. The block loads the packaged authoring procedure for substantial library work; that procedure covers the cumulative domain map, spec, and skill tree, source review, task checks, and revision-bound outcomes. It updates the file that already contains either Intent managed block, or creates `AGENTS.md` when neither exists. It cannot be combined with `--review`, `--map`, `--print-prompt`, `--global`, or `--global-only`. See [Quick Start for Maintainers](../getting-started/quick-start-maintainers). + +> [!NOTE] Maintainer installation writes guidance +> It does not add Intent to `package.json`, configure consumer skill permissions, install agent hooks, or add CI. The managed block uses the detected package manager's runner with `@tanstack/intent@latest`. + ### Default install If `intent.skills` is already configured, including through workspace inheritance, `install` only updates guidance. It does not prompt or change `package.json`. Run `intent install --review` to change permissions. @@ -103,7 +112,7 @@ Supported config files: `AGENTS.md`, `CLAUDE.md`, `.cursorrules`, `.github/copil ## Default output -The default block tells agents to discover skills and load matching guidance on demand: +The default block tells agents to discover skills and load matching guidance on demand. This npm example uses the fallback runner; pnpm, Yarn, and Bun projects receive their detected `@latest` runner instead: ```markdown diff --git a/docs/cli/intent-list.md b/docs/cli/intent-list.md index 7fe6438e..967bf281 100644 --- a/docs/cli/intent-list.md +++ b/docs/cli/intent-list.md @@ -25,6 +25,9 @@ npx @tanstack/intent@latest list [--json] [--debug] [--global] [--global-only] [ ## Behavior +> [!NOTE] +> `list` is the consumer catalog for skills shipped by project and workspace dependencies. Library maintainers load Intent's packaged authoring procedures through `intent meta`, `intent scaffold`, or the installed maintainer block. + ### Default list Intent scans project and workspace dependencies, applies `package.json#intent.skills`, then removes packages and skills matched by `intent.exclude`. It uses project `node_modules` when available and Yarn's PnP API in PnP projects without usable `node_modules`. @@ -81,7 +84,7 @@ Text output includes: - A skill tree grouped by package, with descriptions and commands to load each skill. - Version conflicts and discovery warnings, when present. -Load commands use the detected package manager and preserve the selected global scan scope. `SOURCE` distinguishes local discovery from explicit global scanning. +Load commands use the detected package manager's `@tanstack/intent@latest` runner and preserve the selected global scan scope. `SOURCE` distinguishes local discovery from explicit global scanning. Text output and discovery warnings go to stdout. Policy notices and `--debug` details go to stderr. @@ -99,7 +102,8 @@ Text output and discovery warnings go to stdout. Policy notices and `--debug` de "packageVersion": "5.0.0", "packageSource": "local", "skillName": "fetching", - "description": "Query data fetching patterns", + "description": "Use when fetching and caching server data with TanStack Query.", + "purpose": "Query data fetching patterns", "type": "core", "framework": "react" } @@ -124,6 +128,8 @@ Text output and discovery warnings go to stdout. Policy notices and `--debug` de | Field | Meaning | | --- | --- | | `skills` | Available skills. `use` is the portable `#` identity; `type` and `framework` are optional. | +| Skill `description` | Standard agent-discovery text describing when to use the skill. Also used in the text listing. | +| Skill `purpose` | Optional descriptive explanation from `metadata.purpose`, kept separate from activation guidance. Omitted from JSON when absent. | | `packages` | Selected packages, their source and location, and permitted skill counts. | | `hiddenSourceCount` | Number of packages hidden by the explicit allowlist. | | `hiddenSources` | Objects with `name` and `skillCount` in human sessions, even without `--show-hidden`. Always empty in agent sessions. | @@ -156,6 +162,7 @@ JSON includes diagnostics in the object instead of printing separate warning or - [intent install](./intent-install) - [intent load](./intent-load) +- [intent meta](./intent-meta) - [intent exclude](./intent-exclude) - [Configuration](../concepts/configuration) - [Trust model](../concepts/trust-model) diff --git a/docs/cli/intent-review.md b/docs/cli/intent-review.md new file mode 100644 index 00000000..92d906b7 --- /dev/null +++ b/docs/cli/intent-review.md @@ -0,0 +1,211 @@ +--- +title: intent review +id: intent-review +--- + +`intent review` shows which library skills and planning records need review after source changes. Completed reviews are remembered until their source or guidance changes again. + +```bash +npx @tanstack/intent@latest review [dir] [--base ] [--json] [--check] [--record ] [--github-review] [--package-label