Skip to content

Commit cca3dc0

Browse files
committed
docs
1 parent 88179e6 commit cca3dc0

51 files changed

Lines changed: 301 additions & 190 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.agents/AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@
2525
- Parity: Don't reinvent the wheel. Before designing APIs or architecture, study how proven OSS projects solve the same problem — Drizzle (schema/ORM), tRPC (procedures/middleware), shadcn (CLI/codegen), better-auth (plugin system/auth). Adopt their patterns when applicable. Do `ls` in `..` directory to find the respective repositories, then inspect their source code when needed.
2626
- DX: Optimize for the absolute best developer experience. CLI must be first-class for agents — deterministic, machine-readable output (--json), non-interactive defaults (--yes), composable commands. Every API surface should be intuitive for both humans and AI agents.
2727
- Docs (www/): NEVER write changelog-style language ("has been removed", "new feature", "previously", "now supports"). Docs are user-facing reference for the LATEST state only. Write as if no prior version exists. No migration notes, no "what changed" — just document what IS. Follow docs/solutions/style.md for writing tone/structure.
28-
- Docs sync: When updating www/ docs, also update the corresponding content in packages/kitcn/skills/convex/SKILL.md or packages/kitcn/skills/convex/references/ to stay synced. Follow packages/kitcn/skills/convex/references/setup/doc-guidelines.md for compression/placement rules.
29-
- Plugins: ALWAYS read packages/kitcn/skills/convex/references/features/create-plugins.md before creating or modifying plugins. Keep it synced when any plugin API changes in the package.
30-
- Intent maintainer loop: use `bunx intent scaffold` when you need new skills or a major skill reshuffle; for normal work, update docs and `packages/kitcn/skills/convex/**` in the same diff; run `bunx intent validate skills` and `bunx intent stale`; keep `@tanstack/intent`, `bin/intent.js`, `bin.intent`, and package `files` wired; verify with `npm pack --json --dry-run ./packages/kitcn`; after release, treat `intent feedback` as product input — tighten the skill if wording is wrong, fix the API if the same workaround keeps repeating.
28+
- Docs sync: When updating www/ docs, also update the corresponding content in packages/kitcn/skills/kitcn/SKILL.md or packages/kitcn/skills/kitcn/references/ to stay synced. Follow packages/kitcn/skills/kitcn/references/setup/doc-guidelines.md for compression/placement rules.
29+
- Plugins: ALWAYS read packages/kitcn/skills/kitcn/references/features/create-plugins.md before creating or modifying plugins. Keep it synced when any plugin API changes in the package.
30+
- Intent maintainer loop: use `bunx intent scaffold` when you need new skills or a major skill reshuffle; for normal work, update docs and `packages/kitcn/skills/kitcn/**` in the same diff; run `bunx intent validate skills` and `bunx intent stale`; keep `@tanstack/intent`, `bin/intent.js`, `bin.intent`, and package `files` wired; verify with `npm pack --json --dry-run ./packages/kitcn`; after release, treat `intent feedback` as product input — tighten the skill if wording is wrong, fix the API if the same workaround keeps repeating.
3131
- Always use @.agents/rules/changeset.mdc when updating packages to write a changeset before completing
3232
- After any package modification, run `bun --cwd packages/kitcn build`
3333
- Use tdd skill for package updates that add or change live behavior.

.agents/rules/changeset-doc-sync.mdc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Read every doc in www and packages/kitcn/skills/convex, sync to active changeset(s), and track with checkmarks.
2+
description: Read every doc in www and packages/kitcn/skills/kitcn, sync to active changeset(s), and track with checkmarks.
33
---
44

55
# Changeset Doc Sync
@@ -33,7 +33,7 @@ Use this workflow when release docs must match current changeset content.
3333
- Include every file in:
3434
- `www/**/*.md`
3535
- `www/**/*.mdx`
36-
- `packages/kitcn/skills/convex/**/*.md`
36+
- `packages/kitcn/skills/kitcn/**/*.md`
3737
- Keep `/example` crosswalk checklist in `task_plan.md` in sync during the run.
3838

3939
5. Read every listed doc and sync:
@@ -68,10 +68,10 @@ Use this workflow when release docs must match current changeset content.
6868
- [ ] `www/content/docs/a.mdx` — pending
6969
- [ ] `www/content/docs/b.mdx` — pending
7070

71-
### Phase: Doc Sync Checklist (packages/kitcn/skills/convex)
71+
### Phase: Doc Sync Checklist (packages/kitcn/skills/kitcn)
7272

73-
- [ ] `packages/kitcn/skills/convex/SKILL.md` — pending
74-
- [ ] `packages/kitcn/skills/convex/references/setup/index.md` — pending
73+
- [ ] `packages/kitcn/skills/kitcn/SKILL.md` — pending
74+
- [ ] `packages/kitcn/skills/kitcn/references/setup/index.md` — pending
7575

7676
### Phase: /example-to-doc Crosswalk (required)
7777

@@ -96,15 +96,15 @@ Use this workflow when release docs must match current changeset content.
9696

9797
- [ ] `www/path/to/doc.mdx` — pending
9898

99-
## packages/kitcn/skills/convex docs
99+
## packages/kitcn/skills/kitcn docs
100100

101-
- [ ] `packages/kitcn/skills/convex/SKILL.md` — pending
102-
- [ ] `packages/kitcn/skills/convex/references/setup/index.md` — pending
101+
- [ ] `packages/kitcn/skills/kitcn/SKILL.md` — pending
102+
- [ ] `packages/kitcn/skills/kitcn/references/setup/index.md` — pending
103103

104104
## Synced
105105

106106
- [x] `www/path/to/doc.mdx` — updated for `@convex/api` migration
107-
- [x] `packages/kitcn/skills/convex/references/setup/index.md` — no change needed
107+
- [x] `packages/kitcn/skills/kitcn/references/setup/index.md` — no change needed
108108
```
109109

110110
## Suggested commands
@@ -115,5 +115,5 @@ git diff --stat -- example
115115
git diff -- example
116116
find .changeset -maxdepth 1 -type f -name '*.md' ! -name 'README.md' | sort
117117
find www -type f \( -name '*.md' -o -name '*.mdx' \) | sort
118-
{ echo 'packages/kitcn/skills/convex/SKILL.md'; find packages/kitcn/skills/convex/references -type f -name '*.md' | sort; }
118+
{ echo 'packages/kitcn/skills/kitcn/SKILL.md'; find packages/kitcn/skills/kitcn/references -type f -name '*.md' | sort; }
119119
```

.agents/rules/convex.mdc

Lines changed: 0 additions & 1 deletion
This file was deleted.

.agents/rules/sync-convex-auth.mdc

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Read relevant hits, especially notes about:
142142
- token, JWT, JWKS, cookie, and session handling
143143
- schema generation, plugin reconciliation, and generated auth contracts
144144
- React, Solid, Next.js, and TanStack Start provider behavior
145-
- scaffold templates, docs, and `packages/kitcn/skills/convex/**`
145+
- scaffold templates, docs, and `packages/kitcn/skills/kitcn/**`
146146
- local hacks that might be obsolete after upstream changes
147147

148148
## 4. Classify Every Upstream Change
@@ -230,16 +230,19 @@ Opportunity: <one-sentence selected slice>
230230
Class: <security | compatibility | bugfix | cleanup | agentic | feature | docs | tests>
231231

232232
Evidence:
233+
233234
- Upstream commits: <short commit list or summary>
234235
- Upstream diff: <refs and files>
235236
- Kitcn evidence: <local files and docs/solutions notes>
236237

237238
Implementation:
239+
238240
- <specific files or surfaces to inspect first>
239241
- <expected code/doc/test shape>
240242
- <anything explicitly ignored as irrelevant>
241243

242244
Acceptance:
245+
243246
- <focused tests/checks>
244247
- <package build if packages/kitcn changes>
245248
- <fixtures commands if scaffold output changes>
@@ -263,9 +266,9 @@ Upstream: <upstream-owner>/<repo-name>
263266
Range: <fork-ref>..<upstream-ref>
264267
Behind: <count>
265268

266-
| Class | Opportunity | Evidence | Decision |
267-
| --- | --- | --- | --- |
268-
| bugfix | ... | ... | selected |
269+
| Class | Opportunity | Evidence | Decision |
270+
| ------ | ----------- | -------- | -------- |
271+
| bugfix | ... | ... | selected |
269272

270273
Delegating to task: <selected slice>
271274
```

.agents/skills/changeset-doc-sync/SKILL.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
description: Read every doc in www and packages/kitcn/skills/convex, sync to active changeset(s), and track with checkmarks.
2+
description: Read every doc in www and packages/kitcn/skills/kitcn, sync to active changeset(s), and track with checkmarks.
33
name: changeset-doc-sync
44
metadata:
55
skiller:
@@ -37,7 +37,7 @@ Use this workflow when release docs must match current changeset content.
3737
- Include every file in:
3838
- `www/**/*.md`
3939
- `www/**/*.mdx`
40-
- `packages/kitcn/skills/convex/**/*.md`
40+
- `packages/kitcn/skills/kitcn/**/*.md`
4141
- Keep `/example` crosswalk checklist in `task_plan.md` in sync during the run.
4242

4343
5. Read every listed doc and sync:
@@ -72,10 +72,10 @@ Use this workflow when release docs must match current changeset content.
7272
- [ ] `www/content/docs/a.mdx` — pending
7373
- [ ] `www/content/docs/b.mdx` — pending
7474

75-
### Phase: Doc Sync Checklist (packages/kitcn/skills/convex)
75+
### Phase: Doc Sync Checklist (packages/kitcn/skills/kitcn)
7676

77-
- [ ] `packages/kitcn/skills/convex/SKILL.md` — pending
78-
- [ ] `packages/kitcn/skills/convex/references/setup/index.md` — pending
77+
- [ ] `packages/kitcn/skills/kitcn/SKILL.md` — pending
78+
- [ ] `packages/kitcn/skills/kitcn/references/setup/index.md` — pending
7979

8080
### Phase: /example-to-doc Crosswalk (required)
8181

@@ -100,15 +100,15 @@ Use this workflow when release docs must match current changeset content.
100100

101101
- [ ] `www/path/to/doc.mdx` — pending
102102

103-
## packages/kitcn/skills/convex docs
103+
## packages/kitcn/skills/kitcn docs
104104

105-
- [ ] `packages/kitcn/skills/convex/SKILL.md` — pending
106-
- [ ] `packages/kitcn/skills/convex/references/setup/index.md` — pending
105+
- [ ] `packages/kitcn/skills/kitcn/SKILL.md` — pending
106+
- [ ] `packages/kitcn/skills/kitcn/references/setup/index.md` — pending
107107

108108
## Synced
109109

110110
- [x] `www/path/to/doc.mdx` — updated for `@convex/api` migration
111-
- [x] `packages/kitcn/skills/convex/references/setup/index.md` — no change needed
111+
- [x] `packages/kitcn/skills/kitcn/references/setup/index.md` — no change needed
112112
```
113113

114114
## Suggested commands
@@ -119,5 +119,5 @@ git diff --stat -- example
119119
git diff -- example
120120
find .changeset -maxdepth 1 -type f -name '*.md' ! -name 'README.md' | sort
121121
find www -type f \( -name '*.md' -o -name '*.mdx' \) | sort
122-
{ echo 'packages/kitcn/skills/convex/SKILL.md'; find packages/kitcn/skills/convex/references -type f -name '*.md' | sort; }
122+
{ echo 'packages/kitcn/skills/kitcn/SKILL.md'; find packages/kitcn/skills/kitcn/references -type f -name '*.md' | sort; }
123123
```

.agents/skills/convex/SKILL.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

.agents/skills/kitcn

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../packages/kitcn/skills/kitcn

.agents/skills/sync-convex-auth/SKILL.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Read relevant hits, especially notes about:
146146
- token, JWT, JWKS, cookie, and session handling
147147
- schema generation, plugin reconciliation, and generated auth contracts
148148
- React, Solid, Next.js, and TanStack Start provider behavior
149-
- scaffold templates, docs, and `packages/kitcn/skills/convex/**`
149+
- scaffold templates, docs, and `packages/kitcn/skills/kitcn/**`
150150
- local hacks that might be obsolete after upstream changes
151151

152152
## 4. Classify Every Upstream Change
@@ -234,16 +234,19 @@ Opportunity: <one-sentence selected slice>
234234
Class: <security | compatibility | bugfix | cleanup | agentic | feature | docs | tests>
235235

236236
Evidence:
237+
237238
- Upstream commits: <short commit list or summary>
238239
- Upstream diff: <refs and files>
239240
- Kitcn evidence: <local files and docs/solutions notes>
240241

241242
Implementation:
243+
242244
- <specific files or surfaces to inspect first>
243245
- <expected code/doc/test shape>
244246
- <anything explicitly ignored as irrelevant>
245247

246248
Acceptance:
249+
247250
- <focused tests/checks>
248251
- <package build if packages/kitcn changes>
249252
- <fixtures commands if scaffold output changes>
@@ -267,9 +270,9 @@ Upstream: <upstream-owner>/<repo-name>
267270
Range: <fork-ref>..<upstream-ref>
268271
Behind: <count>
269272

270-
| Class | Opportunity | Evidence | Decision |
271-
| --- | --- | --- | --- |
272-
| bugfix | ... | ... | selected |
273+
| Class | Opportunity | Evidence | Decision |
274+
| ------ | ----------- | -------- | -------- |
275+
| bugfix | ... | ... | selected |
273276

274277
Delegating to task: <selected slice>
275278
```

.claude/commands/clone.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
Dig into /tmp/cc-repos/drizzle-v1 for Drizzle v1 and /tmp/cc-repos/drizzle-orm-docs for Drizzle ORM docs - it's the latest version of Drizzle.
22
Make sure we maximize mirroring drizzle-v1 - dont forget all ts answers are in drizzle repo, dig into it when needed. they master more typescript than you. drizzle has many db integrations so just pick the most relevant one - making sure we mirror all typing magic - dig into /tmp/cc-repos/convex-backend if you need to dig into convex typing, testing or src code. We also have /tmp/cc-repos/convex-ents if needed. Any "new features" not part of drizzle-v1 should feel like an extension of drizzle parity. Not "separate helpers". If you need to read convex docs, see /tmp/cc-repos/convex-backend/npm-packages/docs/docs.
3-
SAME for testing / type testing - but when you need to test convex part, see `.claude/skills/convex/references/testing.md` or convex-backend/npm-packages tests. Use tdd skill `.agents/skills/tdd/SKILL.md` when relevant. We don't want to reinvent the wheel, but we want the closest API to Drizzle. At the end of each package change, make sure you didn't break the types: `bun typecheck` at root and `bun run test` at root.
3+
SAME for testing / type testing - but when you need to test convex part, see `.claude/skills/kitcn/references/testing.md` or convex-backend/npm-packages tests. Use tdd skill `.agents/skills/tdd/SKILL.md` when relevant. We don't want to reinvent the wheel, but we want the closest API to Drizzle. At the end of each package change, make sure you didn't break the types: `bun typecheck` at root and `bun run test` at root.

.claude/commands/sync-skill.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
description: Sync doc changes from www/content/docs/ into packages/kitcn/skills/convex/
2+
description: Sync doc changes from www/content/docs/ into packages/kitcn/skills/kitcn/
33
---
44

55
## Task
66

7-
Sync recent doc changes into `packages/kitcn/skills/convex/` so the skill stays current.
7+
Sync recent doc changes into `packages/kitcn/skills/kitcn/` so the skill stays current.
88

99
**Input**: $ARGUMENTS (doc file path, PR diff, or "all" to scan for drift)
1010

0 commit comments

Comments
 (0)