Add a tiny end-to-end example to README/docs
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Domain
- documentation
Research direction
Start at the README's Get Started section and check whether a fuller example already exists in the docs or examples directory. Add a small end-to-end example covering a spec or PRD fragment, the command or template used, and the resulting artifact for an AI coding agent, or link to an existing example; done means newcomers can follow the workflow without the blank-page problem.
Written by the indexing model from the issue text.
Description
I was looking through Spec Kit and the tagline “Define what to build before building it — with any AI coding agent” makes the goal clear, but I had a little trouble forming a mental model of the actual workflow from the README alone.
It would help newcomers to include a very small example near the Get Started section: a short spec file or PRD fragment, the command/template used to process it, and what the next artifact looks like when handed to an agent like Copilot. Even a contrived example like “add a /health endpoint” would make the boundaries clearer.
If a fuller example already lives in docs or an examples directory, a direct link from the README would still be useful. The main benefit is reducing the blank-page problem for people trying to map spec-driven development onto their own repo.
- Dominant language
- Python
- Stars
- 138k
- Forks
- 12.4k
- Avg merge
- 3d 6h
- Merged PRs (30d)
- 145
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from github/spec-kit
-
triage-can-wait
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
enhancement needs-triage triage-can-wait
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
-
bundle-submission needs-info triage-can-wait validation-failed
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
author-awaiting enhancement needs-triage preset-submission triage-can-wait validation-failed
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
author-awaiting enhancement extension-submission needs-triage triage-can-wait validation-failed
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
learningequality/ricecooker#747 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
BSData/horus-heresy-3rd-edition#3171 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
run-llama/llama_index#23199 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
KhronosGroup/glTF-Blender-IO#2769 ·