Review README strategy + update #1094

New issue

Closed

opened 2025-10-14 16:50:25 -06:00 by navan · 0 comments

navan commented

2025-10-14 16:50:25 -06:00

Owner

Originally created by @eyaltoledano on 3/29/2025

Raw thoughts will improve later:

Currently we have two main readmes — the readme describing the Taskmaster project and repository, and the readme that gets exported as taskmaster_readme along the package, and is meant to be used by Cursor as a means of better understanding how to use the system additional to the cursor/.rules that ship with Taskmaster
There’s some overlap between the two readmes but they serve different purposes. We should ideally be shipping task-master with a single readme file
Need to review and consolidate the README that gets shipped with task-master
Check for any missing documentation relative to new functionality, especially the MCP server

*Originally created by @eyaltoledano on 3/29/2025* Raw thoughts will improve later: - Currently we have two main readmes — the readme describing the Taskmaster project and repository, and the readme that gets exported as taskmaster_readme along the package, and is meant to be used by Cursor as a means of better understanding how to use the system additional to the cursor/.rules that ship with Taskmaster - There’s some overlap between the two readmes but they serve different purposes. We should ideally be shipping task-master with a single readme file - Need to review and consolidate the README that gets shipped with task-master - Check for any missing documentation relative to new functionality, especially the MCP server