mirror of
https://github.com/eyaltoledano/claude-task-master.git
synced 2026-01-30 06:12:05 +00:00
docs: Recommend .md extension for PRD files (#1397)
* docs: Clarify Claude Code .claude configuration behavior and recommend .md for PRDs This addresses two documentation improvements: 1. **Claude Code Configuration Behavior (#1180)** - Added comprehensive section explaining how Task Master interacts with Claude Code's .claude configuration - Clarified that Task Master only passes MCP config when claudeCode.mcpServers is configured - Documented precedence: explicit Task Master config vs Claude CLI defaults - Provided practical examples for different configuration scenarios - Added recommendations for deterministic vs. existing-setup workflows 2. **PRD File Extension Recommendation** - Updated all examples to use .md extension instead of .txt for PRD files - Added prominent note explaining benefits of .md: syntax highlighting, proper rendering, better collaboration - Updated directory structure diagrams and workflow examples - Clarified that both extensions work, but .md is recommended for editor support Files modified: - docs/examples/claude-code-usage.md: Added "Claude Code Configuration Behavior" section - assets/AGENTS.md: Updated all PRD references to use .md, added PRD format note Resolves: eyaltoledano/claude-task-master#1180 * chore: Add changeset and require changesets for PRs - Added changeset for documentation updates (patch) - Updated CLAUDE.md to require changesets for all PRs * docs: Simplify PR to only recommend .md extension for PRDs Based on feedback from @ben-vargas: **Removed:** - Changeset file (not needed for docs-only PR) - Claude Code `.claude` configuration behavior documentation (will become stale when upgrading to ai-sdk-provider-claude-code v2.0.0+ which uses @anthropic-ai/claude-agent-sdk) **Updated:** - CLAUDE.md changeset guidelines: clarified changesets are only needed for code changes, not docs-only PRs **Kept:** - PRD file format recommendation: Updated all examples to use `.md` extension instead of `.txt` for better editor support, syntax highlighting, and rendering - Added note explaining benefits of `.md` format This keeps the PR focused on the non-controversial PRD format improvement and avoids documenting behavior that will soon change. Addresses feedback in: #1180 * docs: Update apps/docs to recommend .md extension for PRD files Applied the same PRD format recommendations to the user-facing documentation site: - apps/docs/getting-started/quick-start/prd-quick.mdx: - Updated template references from .txt to .md - Added explanation of .md benefits in note box - Updated all command examples to use .md extension - Updated file naming examples - apps/docs/capabilities/rpg-method.mdx: - Updated RPG template reference to .md - Updated standard template reference to .md - Updated parse-prd command examples - Updated workflow examples Addresses @Crunchyman-ralph's request to update apps/docs * refactor: Rename PRD template files from .txt to .md extension Renamed actual template files to match documentation updates: - .taskmaster/templates/example_prd.txt → example_prd.md - .taskmaster/templates/example_prd_rpg.txt → example_prd_rpg.md This ensures the actual files match what we're recommending in the documentation. --------- Co-authored-by: Ben Coombs <bjcoombs@users.noreply.github.com>
This commit is contained in:
@@ -7,7 +7,7 @@
|
||||
```bash
|
||||
# Project Setup
|
||||
task-master init # Initialize Task Master in current project
|
||||
task-master parse-prd .taskmaster/docs/prd.txt # Generate tasks from PRD document
|
||||
task-master parse-prd .taskmaster/docs/prd.md # Generate tasks from PRD document
|
||||
task-master models --setup # Configure AI models interactively
|
||||
|
||||
# Daily Development Workflow
|
||||
@@ -41,10 +41,15 @@ task-master generate # Update task markd
|
||||
|
||||
- `.taskmaster/tasks/tasks.json` - Main task data file (auto-managed)
|
||||
- `.taskmaster/config.json` - AI model configuration (use `task-master models` to modify)
|
||||
- `.taskmaster/docs/prd.txt` - Product Requirements Document for parsing
|
||||
- `.taskmaster/docs/prd.md` - Product Requirements Document for parsing (`.md` extension recommended for better editor support)
|
||||
- `.taskmaster/tasks/*.txt` - Individual task files (auto-generated from tasks.json)
|
||||
- `.env` - API keys for CLI usage
|
||||
|
||||
**PRD File Format:** While both `.txt` and `.md` extensions work, **`.md` is recommended** because:
|
||||
- Markdown syntax highlighting in editors improves readability
|
||||
- Proper rendering when previewing in VS Code, GitHub, or other tools
|
||||
- Better collaboration through formatted documentation
|
||||
|
||||
### Claude Code Integration Files
|
||||
|
||||
- `CLAUDE.md` - Auto-loaded context for Claude Code (this file)
|
||||
@@ -62,11 +67,11 @@ project/
|
||||
│ │ ├── task-1.md # Individual task files
|
||||
│ │ └── task-2.md
|
||||
│ ├── docs/ # Documentation directory
|
||||
│ │ ├── prd.txt # Product requirements
|
||||
│ │ ├── prd.md # Product requirements (.md recommended)
|
||||
│ ├── reports/ # Analysis reports directory
|
||||
│ │ └── task-complexity-report.json
|
||||
│ ├── templates/ # Template files
|
||||
│ │ └── example_prd.txt # Example PRD template
|
||||
│ │ └── example_prd.md # Example PRD template (.md recommended)
|
||||
│ └── config.json # AI models & settings
|
||||
├── .claude/
|
||||
│ ├── settings.json # Claude Code configuration
|
||||
@@ -138,8 +143,8 @@ complexity_report; // = task-master complexity-report
|
||||
# Initialize Task Master
|
||||
task-master init
|
||||
|
||||
# Create or obtain PRD, then parse it
|
||||
task-master parse-prd .taskmaster/docs/prd.txt
|
||||
# Create or obtain PRD, then parse it (use .md extension for better editor support)
|
||||
task-master parse-prd .taskmaster/docs/prd.md
|
||||
|
||||
# Analyze complexity and expand tasks
|
||||
task-master analyze-complexity --research
|
||||
|
||||
Reference in New Issue
Block a user