Skip to content

Commit 798cb4e

Browse files
authored
Consolidate all recipe development docs (#1688)
* Move docs into `labs` from `recipes` repo Consolidate docs and update paths * Include `docs/common` when running `ct init` * Fix type errors * Format pass * Clarify event parameter handling/patterns * Clarify CTS naming * Add `handler` to main list * Tweak `lift` description * Expand import example * Clean up event signatures * Remove `on-ctclick` * Add handler to list of main concepts * Remove defunct JSX section * Clarify recipe function structure
1 parent bad906a commit 798cb4e

File tree

19 files changed

+1249
-38
lines changed

19 files changed

+1249
-38
lines changed

.claude/agents/recipe-dev-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ color: orange
77
You are an expert CommonTools recipe development guide specializing in helping users create, modify, and network recipes using the ct utility. You have deep knowledge of the CommonTools framework, recipe patterns, and the ct command-line interface.
88

99
**Critical Prerequisites**:
10-
- You MUST first read `.claude/commands/common/ct.md` for CT binary setup instructions
10+
- You MUST first read `docs/common/CT.md` for CT binary setup instructions
1111
- You MUST search for and read `COMPONENTS.md` and `RECIPES.md` files in the user's recipes folder before working on recipes
1212
- Read `HANDLERS.md` when encountering event handler errors
1313
- The user should have already run the space setup script or have an existing space

.claude/agents/research-specialist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ color: pink
77

88
You are a research specialist with expertise in systematic codebase investigation and technical analysis. Your role is to conduct thorough, methodical research on any topic or question using all available tools and resources.
99

10-
**CRITICAL FIRST STEP**: Before doing anything else, you MUST read .claude/commands/common/ct.md to understand how to use the CommonTools system properly.
10+
**CRITICAL FIRST STEP**: Before doing anything else, you MUST read docs/common/CT.md to understand how to use the CommonTools system properly.
1111

1212
**Your Research Methodology**:
1313

.claude/commands/imagine-recipe.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ This script guides Claude through creating new CommonTools recipes based on user
66

77
**Before starting recipe imagination:**
88
- User should have an existing space or have run the space setup script
9-
- Claude MUST read the common CT setup instructions in `.claude/commands/common/ct.md`
9+
- Claude MUST read the common CT setup instructions in `docs/common/CT.md`
1010

1111
**Recipe Documentation Reference:**
12-
Before working on recipes, search for these documentation files in the user's `recipes` folder:
12+
Before working on recipes, search for these documentation files in the `docs/common` folder:
1313
- `RECIPES.md` - Core recipe development patterns and examples
1414
- `COMPONENTS.md` - Available UI components and usage patterns
1515
- `HANDLERS.md` - Event handler patterns and troubleshooting
@@ -21,7 +21,7 @@ The user provides an initial prompt describing what they want their recipe to do
2121
### STEP 1: Initial Setup and Context
2222

2323
**Read common setup instructions:**
24-
- First, read `.claude/commands/common/ct.md` for shared CT binary setup
24+
- First, read `docs/common/CT.md` for shared CT binary setup
2525
- Follow those instructions for CT binary check, identity management, environment setup
2626
- Collect required parameters (API URL, space name, recipe path, identity file)
2727

.claude/commands/onboarding.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This command provides an interactive tour of the Common Tools platform repositor
1414
"Now that you have the basic idea, what would you like to know more about:
1515

1616
- **Programs that run in this platform** (recipes, charms, UI components)
17-
- **The runtime that enables information flow analysis and storage** (runner, builder, storage)
17+
- **The runtime that enables information flow analysis and storage** (runner, builder, storage)
1818
- **The application layer that users access the platform through** (toolshed, shell, CLI)
1919
- **The LLM tooling layer** (Claude commands, subagents, and development workflows)
2020

@@ -53,7 +53,7 @@ Based on the user's choice in Step 2, follow these focused exploration paths:
5353
**Explore in order:**
5454
1. **Toolshed backend** - Quote from `packages/toolshed/README.md` about hosted platform
5555
2. **Shell frontend** - Quote from `packages/shell/README.md` about user interface
56-
3. **CT CLI** - Overview from `.claude/commands/common/ct.md`
56+
3. **CT CLI** - Overview from `docs/common/CT.md`
5757
4. **How they work together** - Integration points and data flow
5858
5. **Development workflow** - Running local development environment
5959

@@ -71,15 +71,15 @@ Based on the user's choice in Step 2, follow these focused exploration paths:
7171

7272
**Throughout any path, users can access:**
7373
- **Available commands**: List `.claude/commands/` and read `.claude/commands/README.md`
74-
- **Integration setup**: Review `deps.md` for tools and MCP integrations
74+
- **Integration setup**: Review `deps.md` for tools and MCP integrations
7575
- **Development guidelines**: Reference `CLAUDE.md` for coding standards
7676
- **Research commands**: Use `/research` to dive deeper into specific areas
7777

7878
## Adventure Branches
7979

8080
**Users can switch paths or dive deeper:**
8181
- From Recipe Development → explore Runtime internals
82-
- From Runtime → understand Application layer integration
82+
- From Runtime → understand Application layer integration
8383
- From Application layer → try Recipe development
8484
- Or combine multiple paths based on curiosity
8585

@@ -96,15 +96,15 @@ Based on the user's choice in Step 2, follow these focused exploration paths:
9696
**Critical: This is a guided discovery experience, not a fire-hose lecture:**
9797

9898
- **Start tiny and build** - Don't read multiple files at once. Start with one small section
99-
- **Quote small chunks** - Show 2-3 sentences from files, not entire sections
99+
- **Quote small chunks** - Show 2-3 sentences from files, not entire sections
100100
- **Wait for their reaction** - After each quote, ask what they think and WAIT for response
101101
- **Follow their energy** - Only show more based on what sparked their curiosity
102102
- **Never charge ahead** - Resist the urge to show everything; be patient and responsive
103103
- **Let silence be OK** - Give them time to process and respond
104104

105105
**Example flow:**
106106
1. Read just the "What is Common Tools?" section from README.md
107-
2. Quote the first paragraph: "Common Tools is a new distributed computing platform..."
107+
2. Quote the first paragraph: "Common Tools is a new distributed computing platform..."
108108
3. Ask: "What's your first reaction to this?"
109109
4. Wait for user response
110110
5. Based on their response, show ONLY the next relevant small piece
@@ -115,4 +115,4 @@ Based on the user's choice in Step 2, follow these focused exploration paths:
115115
- Don't summarize what you found after reading files
116116
- Don't offer too many paths; the four focused paths are sufficient based on their actual interest
117117

118-
**Key principle:** The user should feel like they're discovering things themselves with Claude as a helpful guide, not receiving a presentation.
118+
**Key principle:** The user should feel like they're discovering things themselves with Claude as a helpful guide, not receiving a presentation.

.claude/commands/recipe-dev.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This script guides Claude through recipe development with the `ct` utility after
66

77
**Before starting recipe development:**
88
- User should have already run the space setup script or have an existing space
9-
- Claude MUST read the common CT setup instructions in `.claude/commands/common/ct.md`
9+
- Claude MUST read the common CT setup instructions in `docs/common/CT.md`
1010

1111
## Script Flow for Claude
1212

@@ -27,7 +27,7 @@ This script guides Claude through recipe development with the `ct` utility after
2727
### STEP 1: Initial Setup and Context (ONLY if no config provided)
2828

2929
**Read common setup instructions:**
30-
- First, read `.claude/commands/common/ct.md` for shared CT binary setup
30+
- First, read `docs/common/CT.md` for shared CT binary setup
3131
- Follow those instructions for:
3232
- CT binary check
3333
- Identity management
@@ -42,7 +42,7 @@ This script guides Claude through recipe development with the `ct` utility after
4242

4343
### STEP 2: Recipe Development Workflows
4444

45-
Before working on recipes it is recommended to search for `COMPONENTS.md` and `RECIPES.md` files in the `recipes` folder provided by the user.
45+
Before working on recipes it is recommended to search for `COMPONENTS.md` and `RECIPES.md` files in the `docs/common` folder.
4646

4747
Read `HANDLERS.md` when confused about event handler errors.
4848

.claude/commands/research.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Task: Research [topic/question]
1515
1616
You are a research specialist. Conduct thorough investigation of the topic using all available tools.
1717
18-
**First, learn how to use ct:** Read .claude/commands/common/ct.md to understand how to use the CommonTools system.
18+
**First, learn how to use ct:** Read docs/common/CT.md to understand how to use the CommonTools system.
1919
2020
**Your Task:**
2121
1. **Consult the wiki first** - Read .claude/commands/search-wiki.md to learn how to check for existing knowledge on this topic
@@ -33,7 +33,7 @@ You are a research specialist. Conduct thorough investigation of the topic using
3333
## Research Methodology
3434

3535
### Core Steps
36-
- **Learn ct usage first** - Read .claude/commands/common/ct.md to understand CommonTools
36+
- **Learn ct usage first** - Read docs/common/CT.md to understand CommonTools
3737
- **Start with wiki search** to avoid duplicating previous research
3838
- Use Task tool for systematic codebase exploration
3939
- Check recent git history and commits
@@ -55,7 +55,7 @@ You are a research specialist. Conduct thorough investigation of the topic using
5555

5656
After research is complete, you MUST ask: "Would you like me to deploy this as a CommonTools research report?"
5757

58-
If yes, use the .claude/commands/deploy-research.md command. Make sure to read .claude/commands/common/ct.md first to understand how to use the CommonTools system properly.
58+
If yes, use the .claude/commands/deploy-research.md command. Make sure to read docs/common/CT.md first to understand how to use the CommonTools system properly.
5959

6060
## When to Use
6161

.claude/commands/search-wiki.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You are a wiki search specialist. Your job is to search the project wiki for rel
1818
- Wiki Charm ID: baedreigkqfmhscbwwfhkjxicogsw3m66nxbetlhlnjkscgbs56hsqjrmkq
1919
2020
**Your Task:**
21-
0. **First, learn how to use ct:** Read .claude/commands/common/ct.md to understand how to use the CommonTools system.
21+
0. **First, learn how to use ct:** Read docs/common/CT.md to understand how to use the CommonTools system.
2222
2323
1. Get all wiki content: `./dist/ct charm get --identity claude.key --api-url https://toolshed.saga-castor.ts.net/ --space 2025-wiki --charm baedreigkqfmhscbwwfhkjxicogsw3m66nxbetlhlnjkscgbs56hsqjrmkq wiki`
2424

.claude/commands/setup-space.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This script guides Claude through setting up a complete space with the `ct` util
77
### STEP 1: Initial Setup Check and Preparation
88

99
**Read common setup instructions:**
10-
- First, read `.claude/commands/common/ct.md` for shared CT binary setup and configuration
10+
- First, read `docs/common/CT.md` for shared CT binary setup and configuration
1111
- Follow those instructions for:
1212
- Checking if user is in the right directory (should be in `labs`)
1313
- CT binary check and build if needed
@@ -78,7 +78,7 @@ This script guides Claude through setting up a complete space with the `ct` util
7878
### Error Handling
7979

8080
**General error handling:**
81-
- Refer to error handling section in `.claude/commands/common/ct.md` for common issues
81+
- Refer to error handling section in `docs/common/CT.md` for common issues
8282
- Don't continue to dependent steps until current step works
8383

8484
**Space setup specific errors:**
@@ -149,7 +149,7 @@ echo '[{"name": "Item 1"}, {"name": "Item 2"}]' | ./dist/ct charm set --identity
149149
## Reference Information for Claude
150150

151151
### Key Commands and Linking Concepts:
152-
- See `.claude/commands/common/ct.md` for:
152+
- See `docs/common/CT.md` for:
153153
- Complete list of CT commands
154154
- Understanding linking syntax and concepts
155155
- Examples of charm-to-charm and well-known ID linking
@@ -164,7 +164,7 @@ echo '[{"name": "Item 1"}, {"name": "Item 2"}]' | ./dist/ct charm set --identity
164164
- Charms list in any space: `baedreiahv63wxwgaem4hzjkizl4qncfgvca7pj5cvdon7cukumfon3ioye`
165165

166166
### Space Setup Specific Notes:
167-
- See `.claude/commands/common/ct.md` for general troubleshooting
167+
- See `docs/common/CT.md` for general troubleshooting
168168
- Recipe files needed for initial setup:
169169
- simple-list.tsx
170170
- gmail.tsx

.claude/commands/update-wiki.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ When you need to update the wiki, follow these steps:
1414

1515
**Process:**
1616

17-
0. **First, learn how to use ct:** Read .claude/commands/common/ct.md to understand how to use the CommonTools system.
17+
0. **First, learn how to use ct:** Read docs/common/CT.md to understand how to use the CommonTools system.
1818

1919
1. Choose appropriate page key following naming conventions:
2020
- Solutions: `[problem-type]-solution` or `fix-[specific-issue]`

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The instructions in this document apply to the entire repository.
1414

1515
### `ct` & Common Tools Framework
1616

17-
Before ever calling `ct` you MUST read `.claude/commands/common/ct.md`.
17+
Before ever calling `ct` you MUST read `docs/common/CT.md`.
1818

1919
### Recipe Development
2020

0 commit comments

Comments
 (0)