docs: clarify where to find spec examples - #4048
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies where readers can find completed Spec-Driven Development examples, addressing discussion #4037.
Changes:
- Distinguishes bundle manifests from generated feature specs.
- Links readers to community walkthroughs.
- Clarifies that community outputs are unofficial examples.
Reviewed by GitHub Copilot.
Show a summary per file
| File | Description |
|---|---|
README.md |
Clarifies bundle examples and links walkthroughs. |
docs/quickstart.md |
Directs readers to templates and completed examples. |
docs/community/walkthroughs.md |
Defines walkthroughs as unofficial read-only examples. |
Review details
Tip
Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 3/3 changed files
- Comments generated: 0
- Review effort level: Balanced
Collaborator
|
Thank you! |
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.
Summary
Clarifies that
examples/bundles/contains bundle manifests rather than filled generated feature specs, and points readers from the README and Quick Start toward community walkthroughs for read-only end-to-end examples.Related to discussion #4037.
Testing
git diff --checknpx --no-install markdownlint-cli2 README.md docs/quickstart.md docs/community/walkthroughs.md