Skip to content

Commit e3a5e4d

Browse files
author
Marvin Zhang
committed
refactor: migrate documentation to new site and remove old files
chore: update command references from 'lspec' to 'lean-spec' fix: adjust temporary directory naming in tests for consistency docs: remove migration guide and custom fields guide from docs style: update README and templates to reflect new command structure test: clean up integration test scripts and remove obsolete files
1 parent 1954003 commit e3a5e4d

Some content is hidden

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

41 files changed

+211
-1188
lines changed

.github/workflows/copilot-setup-steps.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@ jobs:
4343
- name: Build project
4444
run: pnpm run build
4545

46-
- name: Install lspec CLI globally
46+
- name: Install lean-spec CLI globally
4747
run: pnpm link --global
4848

49-
- name: Verify lspec installation
49+
- name: Verify lean-spec installation
5050
run: |
51-
echo "lspec version:"
52-
lspec --version
51+
echo "lean-spec version:"
52+
lean-spec --version
5353
echo ""
54-
echo "lspec is now available globally for Copilot coding agent to use"
54+
echo "lean-spec is now available globally for Copilot coding agent to use"

.vscode/mcp.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"servers": {
33
"lean-spec": {
44
"type": "stdio",
5-
"command": "lspec",
5+
"command": "lean-spec",
66
"args": ["mcp"]
77
}
88
},

AGENTS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,10 @@ When practices conflict, apply principles in priority order:
8383

8484
1. **Read README.md first** - Understand project context
8585
2. **Check specs/** - Review existing specs before starting
86-
3. **Use `lspec --help`** - When unsure about commands, check the built-in help
86+
3. **Use `lean-spec --help`** - When unsure about commands, check the built-in help
8787
4. **Follow LeanSpec principles** - Clarity over documentation
8888
5. **Keep it minimal** - If it doesn't add clarity, cut it
89-
6. **NEVER manually edit system-managed frontmatter** - Fields like `status`, `priority`, `tags`, `assignee`, `transitions`, `created_at`, `updated_at`, `completed_at` are system-managed. Always use `lspec update` or `lspec create` commands. Manual edits will cause metadata corruption and tracking issues. **Exception**: Relationship fields (`depends_on`, `related`) must currently be edited manually as no CLI command exists yet.
89+
6. **NEVER manually edit system-managed frontmatter** - Fields like `status`, `priority`, `tags`, `assignee`, `transitions`, `created_at`, `updated_at`, `completed_at` are system-managed. Always use `lean-spec update` or `lean-spec create` commands. Manual edits will cause metadata corruption and tracking issues. **Exception**: Relationship fields (`depends_on`, `related`) must currently be edited manually as no CLI command exists yet.
9090
7. **Never use nested code blocks** - Markdown doesn't support code blocks within code blocks. If you need to show code examples in documentation, use indentation or describe the structure instead of nesting backticks.
9191

9292
## When to Use Specs
@@ -204,7 +204,7 @@ Required By:
204204
**Critical - Frontmatter Editing Rules**:
205205

206206
**NEVER manually edit these system-managed fields:**
207-
- `status`, `priority`, `tags`, `assignee` - Use `lspec update` commands only
207+
- `status`, `priority`, `tags`, `assignee` - Use `lean-spec update` commands only
208208
- `transitions`, `created_at`, `updated_at`, `completed_at` - Automatically managed by the system
209209
- Manual edits will corrupt metadata, break tracking, and cause validation failures
210210

docs-site/docs/guide/getting-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ For a complete command reference, see [CLI Commands](/docs/reference/cli).
185185

186186
## AI Integration (Optional)
187187

188-
LeanSpec works great with AI coding agents. When you ran `lspec init`, it created `AGENTS.md` with instructions for AI agents.
188+
LeanSpec works great with AI coding agents. When you ran `lean-spec init`, it created `AGENTS.md` with instructions for AI agents.
189189

190190
### Quick AI Setup
191191

docs-site/docs/guide/usage/advanced-features/custom-fields.mdx

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -43,19 +43,19 @@ Edit `.lean-spec/config.json`:
4343

4444
**When creating specs:**
4545
```bash
46-
lspec create user-auth --field epic=PROJ-123 --field sprint=42
46+
lean-spec create user-auth --field epic=PROJ-123 --field sprint=42
4747
```
4848

4949
**When updating specs:**
5050
```bash
51-
lspec update 001 --field reviewer=alice --field estimate=large
51+
lean-spec update 001 --field reviewer=alice --field estimate=large
5252
```
5353

5454
**When filtering:**
5555
```bash
56-
lspec list --field epic=PROJ-123
57-
lspec list --field sprint=42
58-
lspec search "API" --field team=backend
56+
lean-spec list --field epic=PROJ-123
57+
lean-spec list --field sprint=42
58+
lean-spec search "API" --field team=backend
5959
```
6060

6161
### Example Configuration
@@ -164,7 +164,7 @@ Documentation: {docs_url}
164164
When you create a spec, all variables are automatically resolved:
165165

166166
```bash
167-
lspec create user-authentication
167+
lean-spec create user-authentication
168168
```
169169

170170
Results in:
@@ -197,7 +197,7 @@ Documentation: https://docs.acme.com
197197

198198
**Basic custom field usage:**
199199
```bash
200-
lspec create user-authentication \
200+
lean-spec create user-authentication \
201201
--field epic=AUTH-2024 \
202202
--field sprint=5 \
203203
--field estimate=3d \
@@ -206,7 +206,7 @@ lspec create user-authentication \
206206

207207
**With all options:**
208208
```bash
209-
lspec create payment-integration \
209+
lean-spec create payment-integration \
210210
--title "Stripe Payment Integration" \
211211
--description "Integrate Stripe for subscription payments" \
212212
--tags backend,payment,api \
@@ -222,12 +222,12 @@ lspec create payment-integration \
222222
**Updating custom fields:**
223223
```bash
224224
# Update custom fields only
225-
lspec update 001-user-authentication \
225+
lean-spec update 001-user-authentication \
226226
--field sprint=6 \
227227
--field estimate=2d
228228

229229
# Update standard and custom fields together
230-
lspec update 001-user-authentication \
230+
lean-spec update 001-user-authentication \
231231
--status in-progress \
232232
--priority high \
233233
--field sprint=6
@@ -236,19 +236,19 @@ lspec update 001-user-authentication \
236236
**Filtering by custom fields:**
237237
```bash
238238
# Filter by epic
239-
lspec list --field epic=AUTH-2024
239+
lean-spec list --field epic=AUTH-2024
240240

241241
# Filter by sprint
242-
lspec list --field sprint=5
242+
lean-spec list --field sprint=5
243243

244244
# Combine with standard filters
245-
lspec list --status in-progress --field sprint=6
245+
lean-spec list --status in-progress --field sprint=6
246246

247247
# Multiple custom fields
248-
lspec list --field epic=AUTH-2024 --field sprint=6
248+
lean-spec list --field epic=AUTH-2024 --field sprint=6
249249

250250
# Search with custom field filter
251-
lspec search "authentication" --field epic=AUTH-2024
251+
lean-spec search "authentication" --field epic=AUTH-2024
252252
```
253253

254254
### Agile Team Setup
@@ -386,13 +386,13 @@ LeanSpec automatically coerces values to the correct type:
386386

387387
```bash
388388
# "42" is converted to number 42
389-
lspec create feature --field sprint=42
389+
lean-spec create feature --field sprint=42
390390

391391
# "true" is converted to boolean true
392-
lspec create feature --field needs_review=true
392+
lean-spec create feature --field needs_review=true
393393

394394
# Arrays work with comma separation
395-
lspec create feature --field teams=backend,frontend
395+
lean-spec create feature --field teams=backend,frontend
396396
```
397397

398398
## Limitations
@@ -408,7 +408,7 @@ If you add custom fields to existing specs:
408408

409409
```bash
410410
# Update existing specs manually or with a script
411-
lspec update 001 --field epic=PROJ-123
411+
lean-spec update 001 --field epic=PROJ-123
412412

413413
# Or edit frontmatter directly in each README.md
414414
```

docs-site/docs/guide/usage/advanced-features/frontmatter.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Date when spec was created (ISO 8601 format).
5252
created: 2025-11-02
5353
```
5454

55-
This is auto-filled when you use `lspec create`.
55+
This is auto-filled when you use `lean-spec create`.
5656

5757
## Optional Fields
5858

@@ -67,7 +67,7 @@ tags: [api, security, mvp]
6767

6868
**Usage:**
6969
```bash
70-
lspec list --tag=api
70+
lean-spec list --tag=api
7171
```
7272

7373
### priority
@@ -87,7 +87,7 @@ priority: high
8787

8888
**Usage:**
8989
```bash
90-
lspec list --priority=high
90+
lean-spec list --priority=high
9191
```
9292

9393
### completed
@@ -129,8 +129,8 @@ You can define custom fields in `.lean-spec/config.json`:
129129

130130
**Usage:**
131131
```bash
132-
lspec create feature --field assignee=alice --field sprint=42
133-
lspec list --field epic=PROJ-123
132+
lean-spec create feature --field assignee=alice --field sprint=42
133+
lean-spec list --field epic=PROJ-123
134134
```
135135

136136
See [Custom Fields](/docs/guide/usage/advanced-features/custom-fields) for details.
@@ -149,7 +149,7 @@ LeanSpec auto-generates visual badges from frontmatter:
149149
- ✅ Complete
150150
- 📦 Archived
151151

152-
These badges are automatically updated when you use `lspec update`.
152+
These badges are automatically updated when you use `lean-spec update`.
153153

154154
## Full Example
155155

@@ -181,7 +181,7 @@ sprint: 42
181181
Recommended approach:
182182

183183
```bash
184-
lspec update 001 --status=complete --priority=critical
184+
lean-spec update 001 --status=complete --priority=critical
185185
```
186186

187187
This updates both frontmatter and visual badges.
@@ -194,7 +194,7 @@ You can also edit frontmatter directly in the file:
194194
2. Modify YAML between `---` markers
195195
3. Save file
196196

197-
Note: Manual edits don't auto-update visual badges. Run `lspec update` to sync.
197+
Note: Manual edits don't auto-update visual badges. Run `lean-spec update` to sync.
198198

199199
## Best Practices
200200

@@ -207,7 +207,7 @@ Establish tag conventions for your team. Examples: `api`, `ui`, `backend`, `secu
207207
:::
208208

209209
:::tip Update Status Regularly
210-
Keep status current. Use `lspec list` to see what's in progress.
210+
Keep status current. Use `lean-spec list` to see what's in progress.
211211
:::
212212

213213
:::tip Don't Over-Customize

docs-site/docs/guide/usage/advanced-features/variables.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@ These variables are available automatically:
3131

3232
### \{name\}
3333

34-
The spec name provided to `lspec create`.
34+
The spec name provided to `lean-spec create`.
3535

3636
```bash
37-
lspec create user-authentication
37+
lean-spec create user-authentication
3838
```
3939

4040
Results in:

docs-site/docs/guide/usage/ai-assisted/agent-configuration.mdx

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Configure AI coding agents to work effectively with LeanSpec through AGENTS.md i
99

1010
## AGENTS.md Overview
1111

12-
`AGENTS.md` serves as permanent instructions for AI coding agents in your repository. When you run `lspec init`, this file is created with LeanSpec guidance.
12+
`AGENTS.md` serves as permanent instructions for AI coding agents in your repository. When you run `lean-spec init`, this file is created with LeanSpec guidance.
1313

1414
**Purpose:**
1515
- Provide context about your project
@@ -48,22 +48,22 @@ Skip specs for:
4848
## Essential Commands
4949

5050
**Discovery:**
51-
- `lspec list` - See all specs
52-
- `lspec search "<query>"` - Find relevant specs
53-
- `lspec board` - Kanban view with project health
54-
- `lspec stats` - Quick project metrics
51+
- `lean-spec list` - See all specs
52+
- `lean-spec search "<query>"` - Find relevant specs
53+
- `lean-spec board` - Kanban view with project health
54+
- `lean-spec stats` - Quick project metrics
5555

5656
**Viewing specs:**
57-
- `lspec view <spec>` - View a spec (formatted)
58-
- `lspec view <spec> --raw` - Get raw markdown
59-
- `lspec view <spec> --json` - Get structured JSON
60-
- `lspec open <spec>` - Open spec in editor
61-
- `lspec files <spec>` - List all files in a spec
57+
- `lean-spec view <spec>` - View a spec (formatted)
58+
- `lean-spec view <spec> --raw` - Get raw markdown
59+
- `lean-spec view <spec> --json` - Get structured JSON
60+
- `lean-spec open <spec>` - Open spec in editor
61+
- `lean-spec files <spec>` - List all files in a spec
6262

6363
**Working with specs:**
64-
- `lspec create <name>` - Create a new spec
65-
- `lspec update <spec> --status <status>` - Update status
66-
- `lspec deps <spec>` - Show dependencies
64+
- `lean-spec create <name>` - Create a new spec
65+
- `lean-spec update <spec> --status <status>` - Update status
66+
- `lean-spec deps <spec>` - Show dependencies
6767

6868
## Spec Frontmatter
6969

@@ -78,14 +78,14 @@ priority: low|medium|high # optional
7878
---
7979
```
8080

81-
**IMPORTANT**: Always use `lspec update` to modify status, priority, tags, and assignee. Never edit frontmatter manually for these system-managed fields.
81+
**IMPORTANT**: Always use `lean-spec update` to modify status, priority, tags, and assignee. Never edit frontmatter manually for these system-managed fields.
8282

8383
## SDD Workflow
8484

85-
1. **Discover** - Check existing specs with `lspec list`
86-
2. **Plan** - Create spec with `lspec create <name>` when needed
85+
1. **Discover** - Check existing specs with `lean-spec list`
86+
2. **Plan** - Create spec with `lean-spec create <name>` when needed
8787
3. **Implement** - Write code, keep spec in sync as you learn
88-
4. **Update** - Mark progress with `lspec update <spec> --status <status>`
88+
4. **Update** - Mark progress with `lean-spec update <spec> --status <status>`
8989
5. **Complete** - Mark complete when done
9090

9191
## Quality Standards
@@ -94,7 +94,7 @@ priority: low|medium|high # optional
9494
- Tests cover critical paths
9595
- Specs stay in sync with implementation
9696
- Always validate before completing work:
97-
- Run `lspec validate` to check spec structure
97+
- Run `lean-spec validate` to check spec structure
9898
- Fix any validation errors before marking complete
9999

100100
## [Project-Specific Rules]
@@ -281,25 +281,25 @@ Ask your AI agent:
281281
```
282282
List all specs in this repository.
283283
```
284-
Expected: Agent uses `lspec list`
284+
Expected: Agent uses `lean-spec list`
285285

286286
**Test 2: Can it read specs?**
287287
```
288288
What does spec 001 describe?
289289
```
290-
Expected: Agent uses `lspec view 001`
290+
Expected: Agent uses `lean-spec view 001`
291291

292292
**Test 3: Can it follow workflow?**
293293
```
294294
Create a spec for user authentication.
295295
```
296-
Expected: Agent uses `lspec create user-authentication`
296+
Expected: Agent uses `lean-spec create user-authentication`
297297

298298
**Test 4: Can it update status?**
299299
```
300300
Mark spec 001 as in-progress.
301301
```
302-
Expected: Agent uses `lspec update 001 --status in-progress`
302+
Expected: Agent uses `lean-spec update 001 --status in-progress`
303303

304304
## Common Pitfalls
305305

@@ -316,7 +316,7 @@ It's important to...
316316
**Good:**
317317
```markdown
318318
1. Read README.md first
319-
2. Check existing specs with `lspec list`
319+
2. Check existing specs with `lean-spec list`
320320
3. Follow LeanSpec principles (see AGENTS.md)
321321
```
322322

docs-site/docs/guide/usage/ai-assisted/mcp-integration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Ask your AI assistant:
104104
List all specs in this project.
105105
```
106106

107-
Expected: AI uses MCP to call `lspec list` and shows results.
107+
Expected: AI uses MCP to call `lean-spec list` and shows results.
108108

109109
```
110110
What does spec 042 describe?
@@ -256,7 +256,7 @@ The LeanSpec MCP server provides these tools to AI assistants:
256256
**Check:**
257257
1. MCP server is configured in settings
258258
2. `cwd` points to correct project directory
259-
3. Project has specs (run `lspec list` manually)
259+
3. Project has specs (run `lean-spec list` manually)
260260
4. Restart AI tool after config changes
261261

262262
### MCP Commands Not Working

0 commit comments

Comments
 (0)