Skip to content

docs: fix directory hierarchy in README examples#2639

Open
hot666666 wants to merge 1 commit into
github:mainfrom
hot666666:docs/fix-readme-directory-hierarchy
Open

docs: fix directory hierarchy in README examples#2639
hot666666 wants to merge 1 commit into
github:mainfrom
hot666666:docs/fix-readme-directory-hierarchy

Conversation

@hot666666
Copy link
Copy Markdown

@hot666666 hot666666 commented May 20, 2026

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 the specs/ directory nested under .specify/:

.specify/
├── memory/
├── scripts/
├── specs/
│   └── 001-my-first-feature/
└── templates/

However, in actual project initialization, the specs/ directory is created at the project root level, and .specify/ contains memory/, scripts/, and templates/:

.
├── .specify/
│   ├── memory/
│   ├── scripts/
│   └── templates/
└── specs/
    └── 001-my-first-feature/

Testing

  • Tested locally with uv run specify --help
  • Ran existing tests with uv sync && uv run pytest
  • Tested with a sample project (if applicable)

AI Disclosure

  • I did not use AI assistance for this contribution
  • I did use AI assistance (describe below)

Used Gemini for hierarchy visualization.

@hot666666 hot666666 changed the title docs: fix directory hierarchy in README examples (#2638) docs: fix directory hierarchy in README examples May 20, 2026
@hot666666 hot666666 force-pushed the docs/fix-readme-directory-hierarchy branch from 6f67dc4 to 7c36f38 Compare May 20, 2026 10:31
@hot666666 hot666666 marked this pull request as ready for review May 20, 2026 10:46
@hot666666 hot666666 requested a review from mnriem as a code owner May 20, 2026 10:46
@mnriem mnriem requested a review from Copilot May 21, 2026 01:24
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/ and specs/ 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

Comment thread README.md
│ └── templates
│ ├── plan-template.md
│ ├── spec-template.md
│ └── tasks-template.md
Comment thread README.md
│ │ ├── setup-plan.sh
│ │ └── setup-tasks.sh
│ └── templates
│ ├── CLAUDE-template.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants