docs: fix directory hierarchy in README examples#2639
Open
hot666666 wants to merge 1 commit into
Open
Conversation
6f67dc4 to
7c36f38
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes the README’s “📋 Detailed Process” directory tree examples to reflect the actual project layout created by spec-kit, specifically that specs/ is created at the repository root (not nested under .specify/).
Changes:
- Update Step 2 example tree to show
.specify/andspecs/as siblings at the repo root. - Update Step 4 example tree similarly, keeping generated spec artifacts under
specs/<feature>/.
Show a summary per file
| File | Description |
|---|---|
| README.md | Corrects the documented directory hierarchy so specs/ is shown at the project root instead of under .specify/. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 2
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
In the
README.md(specifically under "📋 Detailed Process" Step 2: Create project specifications and Step 4: Generate a plan), the directory tree diagrams show thespecs/directory nested under.specify/:However, in actual project initialization, the
specs/directory is created at the project root level, and.specify/containsmemory/,scripts/, andtemplates/:Testing
uv run specify --helpuv sync && uv run pytestAI Disclosure
Used Gemini for hierarchy visualization.