Skip to content

docs: fix script name in directory tree examples#2555

Merged
mnriem merged 3 commits into
github:mainfrom
darion-yaphet:fix/readme-script-name-update-claude-md
May 14, 2026
Merged

docs: fix script name in directory tree examples#2555
mnriem merged 3 commits into
github:mainfrom
darion-yaphet:fix/readme-script-name-update-claude-md

Conversation

@darion-yaphet
Copy link
Copy Markdown
Contributor

Description

The README contains two directory tree examples (in the detailed walkthrough under Steps 2 and 4) that reference update-claude-md.sh. This script no longer exists —
the actual file in scripts/bash/ is setup-tasks.sh. This PR corrects both occurrences so the documented structure matches the real repository layout.

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)

Discrepancy identified and fix generated with Claude Code (Anthropic). Change is a two-line documentation-only update with no functional impact.

Replace update-claude-md.sh with the actual filename setup-tasks.sh
in two directory tree examples (Steps 2 and 4 of the detailed walkthrough).
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

Updates the README walkthrough’s directory tree examples so the listed script names align with the current Spec Kit bash scripts, avoiding references to a removed update-claude-md.sh.

Changes:

  • Replaced update-claude-md.sh with setup-tasks.sh in the Step 2 and Step 4 directory tree examples.
Show a summary per file
File Description
README.md Fixes outdated script name in two documented directory tree examples.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comments suppressed due to low confidence (1)

README.md:592

  • This directory tree implies the feature spec lives under .specify/specs/..., but create-new-feature.sh creates specs in $REPO_ROOT/specs (project root), not inside .specify/. Consider adjusting the tree so specs/001-... is shown at the repo root to avoid confusing users following the walkthrough.
    │  └── setup-tasks.sh
    ├── specs
    │  └── 001-create-taskify
    │      └── spec.md
    └── templates
  • Files reviewed: 1/1 changed files
  • Comments generated: 1

Comment thread README.md Outdated
Comment on lines +645 to +649
@@ -646,7 +646,7 @@ The output of this step will include a number of implementation detail documents
│ ├── common.sh
│ ├── create-new-feature.sh
│ ├── setup-plan.sh
│ └── update-claude-md.sh
│ └── setup-tasks.sh
install_shared_infra() installs scripts under .specify/scripts/bash/
(script_type="sh") or .specify/scripts/powershell/ (script_type="ps"),
not directly under .specify/scripts/. Update docs/installation.md and
the _install_shared_infra docstring to reflect the actual on-disk layout.
Scripts are installed under .specify/scripts/bash/ (or powershell/)
not directly under .specify/scripts/. Fix both tree diagrams in the
Detailed Process walkthrough to match the actual on-disk layout.
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.

Copilot's findings

  • Files reviewed: 3/3 changed files
  • Comments generated: 0 new

@mnriem mnriem requested a review from Copilot May 14, 2026 20:14
@mnriem mnriem merged commit 6322a4d into github:main May 14, 2026
11 checks passed
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.

Copilot's findings

  • Files reviewed: 3/3 changed files
  • Comments generated: 3

Comment thread README.md
Comment on lines 583 to +587
├── scripts
│ ├── check-prerequisites.sh
│ ├── common.sh
│ ├── create-new-feature.sh
│ ├── setup-plan.sh
│ └── update-claude-md.sh
│ └── bash
│ ├── check-prerequisites.sh
│ ├── common.sh
│ ├── create-new-feature.sh
Comment thread README.md
Comment on lines 645 to +649
├── scripts
│ ├── check-prerequisites.sh
│ ├── common.sh
│ ├── create-new-feature.sh
│ ├── setup-plan.sh
│ └── update-claude-md.sh
│ └── bash
│ ├── check-prerequisites.sh
│ ├── common.sh
│ ├── create-new-feature.sh
Comment thread docs/installation.md
Comment on lines +100 to +103
Scripts are installed into a variant subdirectory matching the chosen script type:

- `.specify/scripts/bash/` — contains `.sh` scripts (default on Linux/macOS)
- `.specify/scripts/powershell/` — contains `.ps1` scripts (default on Windows)
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.

3 participants