Skip to content

Commit ccaa5cd

Browse files
michellejwclaude
andcommitted
Use Starlight FileTree and Steps components
- Convert scaffold.md and first-spec.md to .mdx format - Replace plain code block directory tree with interactive FileTree - Add Steps component for sequential instructions - Highlight key files (spec-format.md, 00-overview.md) in FileTree 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 597acd5 commit ccaa5cd

2 files changed

Lines changed: 58 additions & 28 deletions

File tree

src/content/docs/get-started/first-spec.md renamed to src/content/docs/get-started/first-spec.mdx

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Your First Spec
33
description: Write your first specification with AI assistance.
44
---
55

6+
import { Steps } from '@astrojs/starlight/components';
7+
68
Let's write a spec for something simple: a function that calculates the moving average of a time series. This walkthrough shows the full cycle—spec, AI collaboration, implementation, verification.
79

810
## Start with what you need
@@ -158,11 +160,29 @@ The tests come directly from the spec. If they pass, the implementation matches
158160

159161
## The pattern
160162

161-
1. **Write what you know** — Capture requirements, note open questions
162-
2. **Use AI to fill gaps** — Ask about edge cases, tradeoffs, alternatives
163-
3. **Update the spec** — Record decisions, add concrete examples
164-
4. **Implement from the spec** — The spec becomes the prompt
165-
5. **Test against the spec** — Edge cases become test cases
163+
<Steps>
164+
165+
1. **Write what you know**
166+
167+
Capture requirements, note open questions
168+
169+
2. **Use AI to fill gaps**
170+
171+
Ask about edge cases, tradeoffs, alternatives
172+
173+
3. **Update the spec**
174+
175+
Record decisions, add concrete examples
176+
177+
4. **Implement from the spec**
178+
179+
The spec becomes the prompt
180+
181+
5. **Test against the spec**
182+
183+
Edge cases become test cases
184+
185+
</Steps>
166186

167187
The spec is the source of truth. Code and tests verify that truth is implemented correctly.
168188

@@ -172,4 +192,4 @@ You've completed the Get Started path. From here:
172192

173193
- **[The Method](/spec-driven-site/guides/method/)** — Deeper explanation of spec-driven development
174194
- **[AI Collaboration](/spec-driven-site/guides/ai/)** — How to work effectively with AI assistants
175-
- **[Examples](/spec-driven-site/guides/examples/)** — More complete examples across project types
195+
- **[Examples](/spec-driven-site/guides/examples/)** — More complete examples across project types
Lines changed: 32 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Scaffold a Project
33
description: Run the scaffolding script to bootstrap a spec-driven project.
44
---
55

6+
import { FileTree, Steps } from '@astrojs/starlight/components';
7+
68
The scaffolding script creates a project structure with spec templates ready to go. No dependencies—just Python.
79

810
## Quick start
@@ -29,28 +31,28 @@ The script will ask for:
2931

3032
## What you get
3133

32-
```
33-
your-project/
34-
├── specs/
35-
├── spec-format.md # How to write specs (reference this!)
36-
├── 00-overview.md # Your project overview (start here)
37-
├── 01-requirements/
38-
└── functional.md # Requirements template
39-
├── 02-architecture/
40-
└── data-flow.md # If you chose "Data pipeline"
41-
├── 03-implementation/
42-
├── 04-algorithms/ # If you chose "Algorithm implementation"
43-
└── algorithm-template.md
44-
├── 05-validation/ # If you chose "Algorithm implementation"
45-
└── validation-plan.md
46-
└── 99-decisions/
47-
└── adr-000-template.md # Decision record template
48-
├── src/
49-
├── tests/
50-
├── .claude/CLAUDE.md # If you chose Claude Code
51-
├── CONTRIBUTING.md
52-
└── README.md
53-
```
34+
<FileTree>
35+
- your-project/
36+
- specs/
37+
- **spec-format.md** How to write specs (reference this!)
38+
- **00-overview.md** Your project overview (start here)
39+
- 01-requirements/
40+
- functional.md Requirements template
41+
- 02-architecture/
42+
- data-flow.md If you chose "Data pipeline"
43+
- 03-implementation/
44+
- 04-algorithms/ If you chose "Algorithm implementation"
45+
- algorithm-template.md
46+
- 05-validation/ If you chose "Algorithm implementation"
47+
- validation-plan.md
48+
- 99-decisions/
49+
- adr-000-template.md Decision record template
50+
- src/
51+
- tests/
52+
- .claude/CLAUDE.md If you chose Claude Code
53+
- CONTRIBUTING.md
54+
- README.md
55+
</FileTree>
5456

5557
## The templates
5658

@@ -75,12 +77,20 @@ Fill in the brackets, delete the comments as you go.
7577

7678
## After scaffolding
7779

80+
<Steps>
81+
7882
1. `cd your-project`
83+
7984
2. Open `specs/00-overview.md` and describe your project
85+
8086
3. Read `specs/spec-format.md` to understand how specs work here
87+
8188
4. Run `git init` to start version control
89+
8290
5. Start a conversation with your AI assistant about requirements
8391

92+
</Steps>
93+
8494
## Next step
8595

8696
Once you have a project, [write your first spec](/spec-driven-site/get-started/first-spec/).

0 commit comments

Comments
 (0)