mirror of
https://github.com/eyaltoledano/claude-task-master.git
synced 2026-01-30 06:12:05 +00:00
ae4fbc03a4
* 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>
Task Master Documentation
Welcome to the Task Master documentation. This documentation site provides comprehensive guides for getting started with Task Master.
Getting Started
- Quick Start Guide - Complete setup and first-time usage guide
- Requirements - What you need to get started
- Installation - How to install Task Master
Core Capabilities
- MCP Tools - Model Control Protocol integration
- CLI Commands - Command line interface reference
- Task Structure - Understanding tasks and subtasks
Best Practices
- Advanced Configuration - Detailed configuration options
- Advanced Tasks - Working with complex task structures
Need More Help?
If you can't find what you're looking for in these docs, please check the root README.md or visit our GitHub repository.