Skip to content

Commit 759b7f8

Browse files
kunwarVivekclaude
andcommitted
fix(12): revise plans based on checker feedback
- Plan 12-01: Reframe must_haves.truths to be user-observable (was implementation-focused, now user-outcome focused) - Plan 12-02: Add PROD-05 (README quick start) and PROD-06 (docs/TOOLS.md) verification to Task 3, add artifacts/key_links - Plan 12-03: Fix depends_on format from ["12-01", "12-02"] to ["01", "02"] for consistency Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 9e78e2c commit 759b7f8

3 files changed

Lines changed: 68 additions & 16 deletions

File tree

.planning/phases/12-production-release/12-01-PLAN.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ autonomous: true
1212

1313
must_haves:
1414
truths:
15-
- "npm test reports 0 failing tests"
16-
- "All E2E tests either pass or are skipped with documented justification"
17-
- "Test suite completes successfully in CI-like environment"
15+
- "User can install package and run tests without failures blocking release"
16+
- "Production build is verified stable by passing test suite"
17+
- "Package is ready for distribution with documented test coverage"
1818
artifacts:
1919
- path: "src/__tests__/e2e/stdio-transport.e2e.ts"
2020
provides: "Fixed stdio transport E2E tests"

.planning/phases/12-production-release/12-02-PLAN.md

Lines changed: 64 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,21 @@ must_haves:
1515
- "User can configure the MCP server using documented environment variables"
1616
- "User can troubleshoot common issues using the troubleshooting guide"
1717
- "README points to detailed configuration and troubleshooting docs"
18+
- "README has working quick start instructions (PROD-05)"
19+
- "Tool reference documentation is complete with 119 tools (PROD-06)"
1820
artifacts:
1921
- path: "docs/CONFIGURATION.md"
2022
provides: "Complete configuration reference"
2123
min_lines: 100
2224
- path: "docs/TROUBLESHOOTING.md"
2325
provides: "Troubleshooting guide for common issues"
2426
min_lines: 80
27+
- path: "README.md"
28+
provides: "Quick start instructions"
29+
contains: "Quick Start"
30+
- path: "docs/TOOLS.md"
31+
provides: "Tool reference documentation"
32+
min_lines: 1800
2533
key_links:
2634
- from: "README.md"
2735
to: "docs/CONFIGURATION.md"
@@ -31,14 +39,18 @@ must_haves:
3139
to: "docs/TROUBLESHOOTING.md"
3240
via: "markdown link"
3341
pattern: "\\[.*\\]\\(docs/TROUBLESHOOTING\\.md\\)"
42+
- from: "README.md"
43+
to: "docs/TOOLS.md"
44+
via: "markdown link"
45+
pattern: "\\[.*\\]\\(docs/TOOLS\\.md\\)"
3446
---
3547

3648
<objective>
37-
Create comprehensive configuration and troubleshooting documentation.
49+
Create comprehensive configuration and troubleshooting documentation, and verify README quick start and tool reference are complete.
3850

39-
Purpose: PROD-07 and PROD-08 require configuration and troubleshooting guides. These are essential for npm package users to successfully set up and use the MCP server.
51+
Purpose: PROD-05, PROD-06, PROD-07, PROD-08 require complete user documentation. These are essential for npm package users to successfully set up and use the MCP server.
4052

41-
Output: docs/CONFIGURATION.md (all config options), docs/TROUBLESHOOTING.md (common issues/solutions), updated README links.
53+
Output: docs/CONFIGURATION.md (all config options), docs/TROUBLESHOOTING.md (common issues/solutions), verified README quick start, verified docs/TOOLS.md completeness.
4254
</objective>
4355

4456
<execution_context>
@@ -173,10 +185,36 @@ Include copy-pasteable solutions for each issue.
173185
</task>
174186

175187
<task type="auto">
176-
<name>Task 3: Update README with documentation links</name>
177-
<files>README.md</files>
188+
<name>Task 3: Verify README quick start and tool reference, update documentation links</name>
189+
<files>README.md, docs/TOOLS.md</files>
178190
<action>
179-
Update README.md to add links to the new documentation:
191+
**VERIFY README QUICK START (PROD-05):**
192+
193+
1. Check README.md has a "Quick Start" section with:
194+
- Installation command (`npx mcp-github-project-manager` or `npm install -g`)
195+
- Minimum required environment variables (GITHUB_TOKEN, GITHUB_OWNER, GITHUB_REPO)
196+
- Basic usage example
197+
- Link to detailed configuration
198+
199+
2. If Quick Start section is missing or incomplete:
200+
- Add/update Quick Start section near the top of README
201+
- Include 3-5 step getting started guide
202+
- Keep it concise - link to detailed docs for more info
203+
204+
**VERIFY TOOL REFERENCE (PROD-06):**
205+
206+
1. Check docs/TOOLS.md exists and contains documentation for all 119 tools:
207+
```bash
208+
grep -c "^### \`" docs/TOOLS.md # Should show ~119 tool headers
209+
```
210+
211+
2. Verify tool categories are documented:
212+
- Project Management, Issue Management, Sprint Planning
213+
- AI-powered tools, Label Management, etc.
214+
215+
3. If TOOLS.md is missing or incomplete, flag for creation (should already exist from Phase 11)
216+
217+
**UPDATE README DOCUMENTATION LINKS:**
180218

181219
1. Add a "Documentation" section after "Table of Contents" (or update existing one):
182220
```markdown
@@ -200,11 +238,14 @@ Update README.md to add links to the new documentation:
200238
Keep changes minimal - only add/update links, don't restructure the README.
201239
</action>
202240
<verify>
203-
1. README.md contains link to docs/CONFIGURATION.md
204-
2. README.md contains link to docs/TROUBLESHOOTING.md
205-
3. Links are valid markdown format
241+
1. README.md contains "Quick Start" section with installation and basic usage
242+
2. README.md contains link to docs/CONFIGURATION.md
243+
3. README.md contains link to docs/TROUBLESHOOTING.md
244+
4. README.md contains link to docs/TOOLS.md
245+
5. docs/TOOLS.md exists with 119 tools documented (grep count ~119)
246+
6. Links are valid markdown format
206247
</verify>
207-
<done>README.md updated with links to new documentation</done>
248+
<done>README.md verified with quick start, docs/TOOLS.md verified complete (119 tools), all documentation links updated</done>
208249
</task>
209250

210251
</tasks>
@@ -214,22 +255,33 @@ Keep changes minimal - only add/update links, don't restructure the README.
214255
# Verify files exist
215256
test -f docs/CONFIGURATION.md && echo "CONFIGURATION.md exists"
216257
test -f docs/TROUBLESHOOTING.md && echo "TROUBLESHOOTING.md exists"
258+
test -f docs/TOOLS.md && echo "TOOLS.md exists"
217259

218260
# Verify minimum line counts
219261
wc -l docs/CONFIGURATION.md # Should be 100+
220262
wc -l docs/TROUBLESHOOTING.md # Should be 80+
263+
wc -l docs/TOOLS.md # Should be 1800+
264+
265+
# Verify README has Quick Start
266+
grep -i "quick start" README.md
221267

222268
# Verify README links
223269
grep -E "docs/CONFIGURATION\.md" README.md
224270
grep -E "docs/TROUBLESHOOTING\.md" README.md
271+
grep -E "docs/TOOLS\.md" README.md
272+
273+
# Verify tool count
274+
grep -c "^### \`" docs/TOOLS.md # Should be ~119
225275
```
226276
</verification>
227277

228278
<success_criteria>
229279
1. docs/CONFIGURATION.md exists with all config options documented
230280
2. docs/TROUBLESHOOTING.md exists with common issues and solutions
231-
3. README.md links to both new documents
232-
4. PROD-07 and PROD-08 requirements met
281+
3. README.md has Quick Start section (PROD-05)
282+
4. docs/TOOLS.md has 119 tools documented (PROD-06)
283+
5. README.md links to all documentation files
284+
6. PROD-05, PROD-06, PROD-07, PROD-08 requirements met
233285
</success_criteria>
234286

235287
<output>

.planning/phases/12-production-release/12-03-PLAN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ phase: 12-production-release
33
plan: 03
44
type: execute
55
wave: 2
6-
depends_on: ["12-01", "12-02"]
6+
depends_on: ["01", "02"]
77
files_modified:
88
- CHANGELOG.md
99
- package.json

0 commit comments

Comments
 (0)