Skip to content

Commit 02c1da0

Browse files
bkrabachclaude
andauthored
docs: Add workspace pattern guide for serious project development (#87)
This introduces comprehensive documentation for using Amplifier with the workspace pattern - an architectural approach where Amplifier hosts projects as git submodules rather than projects containing Amplifier. Changes: - Add docs/WORKSPACE_PATTERN.md with complete guide covering: - Quick start for immediate setup - Architecture explanation with clear diagrams - Step-by-step setup including git submodule basics - AGENTS.md contract pattern for persistent AI context - Migration path from ai_working/ to workspace pattern - Working with multiple projects - Practical tips and troubleshooting - Update README.md with: - Option 3 in QuickStart for workspace pattern setup - Dedicated section explaining benefits and use cases - Clear links to full documentation Benefits: - Clean version control isolation per component - Independent Amplifier updates without affecting projects - Persistent AI context through AGENTS.md - Scalable to multiple simultaneous projects - Philosophy-driven development with decision filters This pattern is ideal for long-term projects, team collaboration, and situations requiring clear boundaries between tool and work. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude <[email protected]>
1 parent d9e9891 commit 02c1da0

File tree

2 files changed

+583
-0
lines changed

2 files changed

+583
-0
lines changed

README.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,35 @@ amplifier.
104104
claude
105105
```
106106

107+
**Option 3** - Use the workspace pattern for serious projects
108+
109+
For projects that need clean boundaries, independent version control, and persistent AI context:
110+
111+
```bash
112+
# Fork/clone Amplifier as your workspace
113+
git clone https://github.com/microsoft/amplifier.git my-workspace
114+
cd my-workspace
115+
116+
# Add your project as a submodule
117+
git submodule add <your-project-url> my-project
118+
119+
# Set up project context (see guide for AGENTS.md template)
120+
cd my-project
121+
# Create AGENTS.md with project guidance
122+
123+
# Start working
124+
cd ..
125+
claude
126+
```
127+
128+
_In Claude Code:_
129+
```
130+
I'm working on the @my-project/ project within this workspace.
131+
Please read @my-project/AGENTS.md for project-specific guidance.
132+
```
133+
134+
**Why use this?** Clean git history per component, independent Amplifier updates, persistent context across sessions, scalable to multiple projects. See the [Workspace Pattern Guide](docs/WORKSPACE_PATTERN.md) for full details.
135+
107136
---
108137

109138
## What Is Amplifier?
@@ -201,6 +230,27 @@ Enable with:
201230
- Demo-driven development patterns
202231
- Practical tips for effective AI-assisted development
203232

233+
### Workspace Pattern for Serious Projects
234+
235+
**For long-term development**, consider using the workspace pattern where Amplifier hosts your project as a git submodule. This architectural approach provides:
236+
237+
- **Clean boundaries** - Project files stay in project directory, Amplifier stays pristine and updatable
238+
- **Version control isolation** - Each component maintains independent git history
239+
- **Context persistence** - AGENTS.md preserves project guidance across sessions
240+
- **Scalability** - Work on multiple projects simultaneously without interference
241+
- **Philosophy alignment** - Project-specific decision filters and architectural principles
242+
243+
Perfect for:
244+
- Projects that will live for months or years
245+
- Codebases with their own git repository
246+
- Teams collaborating on shared projects
247+
- When you want to update Amplifier without affecting your projects
248+
- Working on multiple projects that need isolation
249+
250+
The pattern inverts the typical relationship: instead of your project containing Amplifier, Amplifier becomes a dedicated workspace that hosts your projects. Each project gets persistent context through AGENTS.md (AI guidance), philosophy documents (decision filters), and clear namespace boundaries using `@project-name/` syntax.
251+
252+
See the [Workspace Pattern Guide](docs/WORKSPACE_PATTERN.md) for complete setup, usage patterns, and migration from `ai_working/`.
253+
204254
## 🎯 Key Features
205255

206256
### Specialized Agents

0 commit comments

Comments
 (0)