Skip to content

Commit 171f726

Browse files
author
root
committed
docs: clarify example spec guidance
1 parent 9d15554 commit 171f726

3 files changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -283,9 +283,11 @@ specify bundle validate --path ./my-bundle # structural + reference checks
283283
specify bundle build --path ./my-bundle # produce a versioned .zip artifact
284284
```
285285

286-
Four ready-to-read example manifests live under
286+
Four ready-to-read example bundle manifests live under
287287
[`examples/bundles/`](examples/bundles/) (product manager, business analyst,
288-
security researcher, developer).
288+
security researcher, developer). These are bundle packaging examples, not
289+
filled generated feature specs; for end-to-end community examples, see the
290+
[community walkthroughs](https://github.github.io/spec-kit/community/walkthroughs.html).
289291

290292
Key guarantees: `info` shows exactly what `install` adds (transparency);
291293
installs are idempotent and confined to the project root; `remove` never touches

docs/community/walkthroughs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
> [!NOTE]
44
> Community walkthroughs are independently created and maintained by their respective authors. They are **not reviewed, nor endorsed, nor supported by GitHub**. Review their content before following along and use at your own discretion.
55
6-
See Spec-Driven Development in action across different scenarios with these community-contributed walkthroughs:
6+
See Spec-Driven Development in action across different scenarios with these community-contributed walkthroughs. They are useful read-only examples of completed flows, but they are not official golden outputs for generated specs, plans, or tasks.
77

88
- **[Greenfield .NET CLI tool](https://github.com/mnriem/spec-kit-dotnet-cli-demo)** — Builds a Timezone Utility as a .NET single-binary CLI tool from a blank directory, covering the full spec-kit workflow: constitution, specify, plan, tasks, and multi-pass implement using GitHub Copilot agents.
99

docs/quickstart.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ This guide will help you get started with Spec-Driven Development using Spec Kit
55
> [!NOTE]
66
> Automation scripts are provided as Bash (`.sh`), PowerShell (`.ps1`), and Python (`.py`) variants. Interactive `specify init` prompts you to choose one; non-interactive runs default to a shell variant for your OS. Pass `--script sh|ps|py` to select explicitly.
77
8-
> [!NOTE]
9-
> Commands are shown here in `/speckit.*` form, but the exact invocation depends on your agent. Some skills-based agents use `$speckit-*` (e.g. Codex, ZCode) or `/skill:speckit-*` (e.g. Kimi). Use whichever form your agent exposes — the steps are otherwise identical.
8+
Commands are shown here in `/speckit.*` form, but the exact invocation depends on your agent. Some skills-based agents use `$speckit-*` (e.g. Codex, ZCode) or `/skill:speckit-*` (e.g. Kimi). Use whichever form your agent exposes — the steps are otherwise identical.
109

1110
## Recommended Process
1211

@@ -136,5 +135,6 @@ Checks the codebase against the spec, plan, and tasks. If it finds gaps, it appe
136135

137136
- See the [Agentic SDD](reference/agentic-sdd.md) reference for full detail on every command
138137
- Read the [complete methodology](https://github.com/github/spec-kit/blob/main/spec-driven.md) for in-depth guidance
139-
- Check out [more examples](https://github.com/github/spec-kit/tree/main/templates) in the repository
138+
- Compare the [core templates](https://github.com/github/spec-kit/tree/main/templates) with
139+
[community walkthroughs](community/walkthroughs.md) to see how Spec-Driven Development is used in real projects
140140
- Explore the [source code on GitHub](https://github.com/github/spec-kit)

0 commit comments

Comments
 (0)