Skip to content

Commit 519298f

Browse files
committed
docs: fix team-ai-directives URL examples in documentation
Replace invalid .git URLs with valid archive/ZIP URLs: - README.md: Update examples to use archive URLs - docs/installation.md: Add archive URL examples - docs/discovery.md: Fix example to use archive URL - docs/quickstart.md: Fix example to use archive URL The validation logic only accepts: - Local directory paths - ZIP file URLs (ending in .zip) - GitHub archive URLs (containing /archive/) The .git URL format is rejected by design.
1 parent c8ac712 commit 519298f

4 files changed

Lines changed: 13 additions & 7 deletions

File tree

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -371,11 +371,14 @@ This fork includes pre-installed extensions:
371371
This fork supports team-ai-directives — a foundation for version-controlled AI agent behavior. Install during project initialization:
372372

373373
```bash
374-
# Install from GitHub repository (ZIP download)
375-
specify init <project> --team-ai-directives https://github.com/your-org/team-ai-directives.git
374+
# Install from GitHub archive (ZIP download)
375+
specify init <project> --team-ai-directives https://github.com/your-org/team-ai-directives/archive/refs/heads/main.zip
376376

377377
# Or from a specific release tag
378378
specify init <project> --team-ai-directives https://github.com/your-org/team-ai-directives/archive/refs/tags/v1.0.0.zip
379+
380+
# Or use a local directory
381+
specify init <project> --team-ai-directives ~/workspace/team-ai-directives
379382
```
380383

381384
The directives are installed to `.specify/extensions/team-ai-directives/` and available to all AI agents via the extension system. Use the `levelup` extension to contribute back to team-ai-directives.

docs/discovery.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -282,9 +282,9 @@ $skillsJson = Discover-Skills -FeatureDescription $featureDescription -TeamDirec
282282
### Example 1: New Feature with Team Directives
283283

284284
```bash
285-
# Initialize project with team-ai-directives
285+
# Initialize project with team-ai-directives (from GitHub archive)
286286
cd my-project
287-
specify init . --team-ai-directives https://github.com/my-org/team-ai-directives.git
287+
specify init . --team-ai-directives https://github.com/my-org/team-ai-directives/archive/refs/heads/main.zip
288288

289289
# Create feature
290290
./create-new-feature.sh --json "Add user authentication with OAuth2"

docs/installation.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,11 @@ Connect to shared team knowledge and standards:
7575
# Use local team-ai-directives directory
7676
uvx --from git+https://github.com/tikalk/agentic-sdlc-spec-kit.git specify init <project_name> --team-ai-directives ~/workspace/team-ai-directives
7777

78-
# Clone from remote repository
79-
uvx --from git+https://github.com/tikalk/agentic-sdlc-spec-kit.git specify init <project_name> --team-ai-directives https://github.com/your-org/team-ai-directives.git
78+
# Install from GitHub archive (ZIP download)
79+
uvx --from git+https://github.com/tikalk/agentic-sdlc-spec-kit.git specify init <project_name> --team-ai-directives https://github.com/your-org/team-ai-directives/archive/refs/heads/main.zip
80+
81+
# Or from a specific release tag
82+
uvx --from git+https://github.com/tikalk/agentic-sdlc-spec-kit.git specify init <project_name> --team-ai-directives https://github.com/your-org/team-ai-directives/archive/refs/tags/v1.0.0.zip
8083
```
8184

8285
## Verification

docs/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This guide will help you get started with Spec-Driven Development using Agentic
1212
**Alignment with 12 Factors:** This stage establishes the foundation guided by [I. Strategic Mindset](https://tikalk.github.io/agentic-sdlc-12-factors/content/strategic-mindset.html) and [II. Context Scaffolding](https://tikalk.github.io/agentic-sdlc-12-factors/content/context-scaffolding.html), positioning the developer as orchestrator and assembling necessary context for AI collaboration.
1313

1414
1. **Project Initialization (`/init`)**
15-
**Action:** From the project root, run the Agentic SDLC Spec Kit `init` command (e.g., `specify init <project> --team-ai-directives https://github.com/your-org/team-ai-directives.git`) to configure local settings and clone the shared `team-ai-directives` modules.
15+
**Action:** From the project root, run the Agentic SDLC Spec Kit `init` command (e.g., `specify init <project> --team-ai-directives https://github.com/your-org/team-ai-directives/archive/refs/heads/main.zip`) to configure local settings and install the shared `team-ai-directives` modules.
1616
**Purpose:** Creates the handshake that brings the repository into the managed Agentic SDLC ecosystem, wiring credentials, endpoints, and shared knowledge needed for subsequent commands.
1717
2. **Establishing the Constitution (`/constitution`)**
1818
**Action:** Within the IDE, execute `/constitution`, importing relevant modules from `team-ai-directives` and adding any project-specific principles.

0 commit comments

Comments
 (0)