docs: add workflow quickstarts - #4258
Merged
Merged
Conversation
Add concise setup and command recipes for SDD, structured bug fixing, and standalone idea assessment. Assisted-by: GitHub Copilot (model: GPT-5.6 Sol, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: af05cfd0-746d-4292-9380-0a785a991cba
Contributor
There was a problem hiding this comment.
Pull request overview
Adds README quickstarts for Spec Kit鈥檚 primary workflows.
Changes:
- Adds SDD lifecycle guidance through convergence.
- Adds bug-fixing and idea-assessment workflows.
- Links new sections from the table of contents.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds three workflow quickstarts and navigation links. |
Review details
馃挕 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Suppressed comments (2)
README.md:77
- The bug-fix quickstart is not directly runnable because
vX.Y.Zis a placeholder for a nonexistent Git tag and this section provides no replacement instruction. Use the versionless install command here so newcomers can execute the advertised quickstart as written.
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX.Y.Z
README.md:96
- The idea-assessment quickstart likewise fails when copied because
vX.Y.Zis not an actual Git tag and readers have not yet reached the later explanation. Make this command executable as shown by using the published package directly.
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX.Y.Z
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Balanced
Tell readers to replace the placeholder in every standalone quickstart with the latest tagged release. Assisted-by: GitHub Copilot (model: GPT-5.6 Sol, autonomous) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Copilot-Session: af05cfd0-746d-4292-9380-0a785a991cba
Collaborator
Author
|
Addressed the quickstart placeholder feedback in commit Posted on behalf of @mnriem by GitHub Copilot (model: GPT-5.6 Sol). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds concise README quickstarts that show how to install Spec Kit and use its three primary workflows:
This gives new users a scannable path from installation to useful outcomes while retaining the detailed walkthrough below.
Testing
Documentation-only change. Rendered the README locally with GitHub-style Markdown and checked the final diff for formatting errors.
uv run specify --helpuv sync && uv run pytestAI Disclosure
README content was authored and refined by GitHub Copilot (model: GPT-5.6 Sol) on behalf of @mnriem through iterative human direction.