roadmap-skill 0.2.8 → 0.2.10

package/CHANGELOG.md

@@ -5,6 +5,65 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.10] - 2026-02-27
+
+### Added
+- **Contributing Section**: Added Contributing section to README (en/zh)
+
+### Changed
+- **README**: Revamped copy for both en/zh versions, improved clarity and tone
+- **Tag ID Workflow**: Unified tag-id handling with deterministic color fallback
+
+
+## [0.2.9] - 2026-02-26
+
+### Added
+- **Development Scripts**: Added `dev:web`, `dev:server`, `dev:full`, and `inspector` npm scripts
+- **Vite Proxy**: Frontend dev server now proxies API requests to backend automatically
+- **Verbose Parameter**: Tools now support `verbose` parameter for compact vs full data responses
+- **Summary Types**: Added `TaskSummary` and `ProjectSummary` types for lightweight responses
+- **MCP Inspector**: Added `npm run inspector` command for debugging MCP server
+
+### Changed
+- **UI Layout**: Moved filter bar to header alongside title for better space usage
+- **Compact Mode**: Optimized spacing, removed tags, reduced margins and padding
+- **Hover Animation**: Reduced card hover displacement from `-translate-y-1` to `-translate-y-0.5`
+- **Create Button**: Changed task creation button color to project theme green
+
+### Fixed
+- **Completed Tasks**: Fixed "All" filter to properly include completed tasks via `includeCompleted` parameter
+
+## [0.2.8] - 2026-02-26
+
+### Fixed
+- **MCP Transport**: Resolved stdio transport issues for better CLI compatibility
+- **Tag System**: Improved tag management and display in task cards
+
+### Changed
+- Updated README with latest features and improvements
+
+## [0.2.7] - 2026-02-26
+
+### Fixed
+- **Static Files Path**: Corrected bundled static files path for npx environment execution
+
+### Added
+- **Release Documentation**: Added release workflow documentation to AGENTS.md
+
+## [0.2.6] - 2026-02-26
+
+### Fixed
+- **Static Files Path**: Resolved static files path resolution for npx execution environment
+
+## [0.2.5] - 2026-02-26
+
+### Added
+- **NovaBoard UI**: Integrated tag system with NovaBoard-style dashboard design
+- **Tag System**: Full tag management with color coding and filtering
+
+### Fixed
+- **Server Path**: Use `__dirname` instead of `process.cwd()` for reliable static files path resolution
+
 ## [0.2.0] - 2026-02-10
 
 ### Added

package/README.md

@@ -5,8 +5,8 @@
 </p>
 
 <p align="center">
-  <strong>Let AI manage your projects, keep Kanban simple</strong><br>
-  Zero-config startup, local data, Agent-native support
+  <strong>Shared roadmap for humans and AI Agents</strong><br>
+  Visual kanban for you. MCP server for Agents. Local-first.
 </p>
 
 <p align="center">
@@ -26,15 +26,15 @@
 
 ---
 
-## Why Roadmap Skill?
+## What Makes It Different
 
-| Your Pain Point | How Roadmap Skill Solves It |
-|----------------|----------------------------|
-| Project data scattered in third-party clouds | **Local-first** — All data stored on your machine, full control, works offline |
-| Copy-pasting task lists when chatting with AI | **Agent-native** — AI reads/writes tasks directly, zero friction in conversation |
-| Text-only management lacks visuals, but traditional tools are bloated | **Beautiful Kanban** — Open browser when needed, drag and drop, doesn't interrupt coding flow |
-| Ideas and bugs from Vibe Coding get forgotten | **Collection Box** — Let Agent capture scattered thoughts, auto-organize todos |
-| Too many tasks, don't know where to start | **Smart Recommendations** — Agent analyzes context, proactively suggests next steps |
+**Shared context** — Chat with your Agent to plan tasks, or edit directly in the Kanban — both stay in sync. Your Agent always sees the latest state.
+
+**Agent-native** — Built as an MCP server. Your AI can create, update, and query tasks directly in conversation.
+
+**Lightweight Kanban** — Open `localhost:7860` when you feel like it, or ask your Agent to open it with `open_web_interface`. Or just stay in chat. All three work.
+
+**Local-first** — Your data lives on your machine. No accounts, no cloud sync, no vendor lock-in.
 
 ---
 
@@ -243,83 +243,74 @@ Follow Windsurf MCP documentation and use:
 
 </details>
 
-</details>
-
-<br>
-
-After setup, simply tell your AI:
-
-> "Create a website redesign project with tasks for homepage, about page, and contact form"
+<details>
+<summary><b>Codex CLI / Codex IDE</b></summary>
 
-The AI will immediately create the project and tasks, saving them to local storage. You can open <http://localhost:7860> anytime to view the visual Kanban board.
+**One-liner (recommended):**
 
----
+```bash
+codex mcp add roadmap -- npx -y roadmap-skill
+```
 
-## Who Is This For?
+**Manual config** — edit `~/.codex/config.toml`:
 
-| Scenario | What Roadmap Skill Does For You |
-|---------|--------------------------------|
-| **Solo Developers** | Manage personal projects through conversation, avoid getting lost in complex tools |
-| **AI Power Users** | Let Agent directly read/write tasks, goodbye to copy-pasting hassle |
-| **Vibe Coders** | Capture inspirations on the fly, automatically save to collection box |
-| **Small Teams** | Simple task assignment and progress tracking, zero learning curve |
-| **Privacy-conscious Users** | Data stored completely locally, never uploaded to any cloud service |
+```toml
+[mcp_servers.roadmap]
+command = "npx"
+args = ["-y", "roadmap-skill"]
+```
 
----
+> **Windows**: No `cmd /c` wrapper needed — Codex handles the subprocess directly.
 
-## Typical Use Cases
+> **Server name**: Must match `^[a-zA-Z0-9_-]+$`. Names with spaces or parentheses are rejected.
 
-### 1. Capture Inspiration During Vibe Coding
+> **Note**: Both Codex CLI and the Codex VSCode extension share the same `~/.codex/config.toml`. A syntax error breaks both.
 
-When discussing new features with AI, suddenly think of an optimization:
+</details>
 
-> "Add this to my collection: Refactor user auth module using JWT + Refresh Token scheme"
+</details>
 
-AI automatically creates the task, and you'll see it in the Kanban later.
+<br>
 
-### 2. Let AI Plan Project Structure
+After setup, simply tell your AI:
 
-Starting a new project? Just ask AI to break it down:
+> "Create a website redesign project with tasks for homepage, about page, and contact form"
 
-> "Create an e-commerce admin dashboard project with product management, order processing, and user permissions modules, broken down into specific development tasks"
+The AI will immediately create the project and tasks, saving them to local storage. You can open <http://localhost:7860> anytime to view the visual Kanban board.
 
-AI auto-creates the project structure. Just open the Kanban in browser and drag tasks to start working.
+---
 
-### 3. Progress Tracking and Status Updates
+## Who Is This For?
 
-Check progress anytime during coding:
+Solo developers, AI power users, and vibe coders who want their Agent to be a real collaborator — not just a code generator.
 
-> "What's the completion percentage of my current project? What high-priority tasks haven't started yet?"
+---
 
-> "Mark the user login feature as completed and create corresponding test tasks"
+## Typical Use Cases
 
-### 4. Team Collaboration and Assignment
+### 1. Capture Ideas Without Breaking Flow
 
-Quickly assign in conversation:
+Mid-session, something comes to mind:
 
-> "Assign frontend page tasks to @zhangsan, deadline this Friday, priority high"
+> "Note this down: switch the auth module to JWT + refresh token rotation"
 
-Team members can view their task list in the Kanban.
+Your Agent creates the task. You stay in flow. Open the Kanban later to review.
 
----
+### 2. Let AI Bootstrap Your Project Plan
 
-## Installation
+Starting something new:
 
-### Requirements
+> "Set up a project for the admin dashboard — product management, orders, and user permissions. Break each into tasks."
 
-- Node.js 18+ (recommended 20+)
+Agent scaffolds the whole structure. You open the board and start dragging.
 
-### Global Install
+### 3. Check In Without Leaving the Chat
 
-```bash
-npm install -g roadmap-skill
-```
+> "What's left on the current project? Anything high priority I haven't touched?"
 
-### Use Without Installing
+> "Mark the login feature done and add a task for writing tests."
 
-```bash
-npx roadmap-skill          # Full MCP server
-```
+No tab switching. No copy-pasting. Just ask.
 
 ---
 

package/README.zh.md

@@ -5,8 +5,8 @@
 </p>
 
 <p align="center">
-  <strong>让 AI 帮你管理项目，让看板回归简洁</strong><br>
-  零配置启动，本地数据，Agent 原生支持
+  <strong>人类与 AI Agent 共享的项目看板</strong><br>
+  你看到的，Agent 也看到。对话里规划，看板里审阅。或者相反。
 </p>
 
 <p align="center">
@@ -26,15 +26,15 @@
 
 ---
 
-## 为什么选择 Roadmap Skill？
+## 这个 MCP 有什么不同？
 
-| 你的困扰 | Roadmap Skill 的解决方式 |
-|---------|-------------------------|
-| 项目数据散落在第三方云端，缺乏安全感 | **本地优先** — 所有数据存储在你的电脑，完全掌控，离线可用 |
-| 和 AI 对话时需要来回粘贴任务列表 | **Agent 原生** — AI 直接读写任务，对话中自然管理，零摩擦 |
-| 纯文本管理缺乏直观性，但传统工具太重 | **美观看板** — 需要时打开浏览器，拖拽即可，不打扰编码流 |
-| Vibe Coding 中的灵感、Bug 随手记在某处就忘了 | **收集箱** — 让 Agent 帮你沉淀零散想法，自动整理待办 |
-| 任务太多不知从何开始，优先级全靠猜 | **智能推荐** — Agent 分析项目上下文，主动建议下一步工作 |
+**人机共享视图** — 在对话里和 Agent 一起规划任务，也可以直接在看板上手动编辑，两种方式实时互通。你和Agent 始终能获取到最新状态。
+
+**Agent 原生** — 以 MCP 服务器形式运行。AI 可以在对话中直接创建、更新、查询任务。
+
+**轻量看板** — 你想看的时候打开 `localhost:7860`。懒得开浏览器？直接让 Agent `/open-web-ui` 也行。
+
+**本地优先** — 数据存在你的机器上。无需账号，无云同步，不依赖任何第三方服务。
 
 ---
 
@@ -241,6 +241,28 @@ Follow Windsurf MCP documentation and use:
 }
 ```
 
+</details>
+<details>
+<summary><b>Codex CLI / Codex IDE</b></summary>
+
+**一键安装（推荐）：**
+
+```bash
+codex mcp add roadmap -- npx -y roadmap-skill
+```
+
+**手动配置** — 编辑 `~/.codex/config.toml`：
+
+```toml
+[mcp_servers.roadmap]
+command = "npx"
+args = ["-y", "roadmap-skill"]
+```
+
+> **Windows**：无需 `cmd /c` 包装 — Codex 会直接管理子进程。
+> **服务器名称**：必须匹配 `^[a-zA-Z0-9_-]+$`，含空格或括号的名称会被拒绝。
+> **注意**：Codex CLI 和 Codex VSCode 扩展共享同一个 `~/.codex/config.toml`，语法错误会同时影响两者。
+
 </details>
 
 </details>
@@ -257,69 +279,33 @@ AI 会立即为你创建项目和任务，并自动写入本地存储。你可
 
 ## 适合谁使用
 
-| 场景 | Roadmap Skill 能为你做什么 |
-|------|---------------------------|
-| **独立开发者** | 用对话管理个人项目，避免在复杂工具中迷失 |
-| **AI 重度用户** | 让 Agent 直接读写任务，告别来回粘贴的繁琐 |
-| **Vibe Coder** | 随手让 AI 记录灵感，自动沉淀到收集箱 |
-| **小团队协作** | 简单的任务分配与进度追踪，无需学习成本 |
-| **隐私敏感者** | 数据完全本地存储，不上传任何云端服务 |
-
----
+独立开发者、AI 重度用户、Vibe Coder — 想让 Agent 真正参与项目协作，而不只是写代码的人。
 
 ## 典型使用场景
 
-### 1. Vibe Coding 中的灵感收集
-
-正在和 AI 讨论新功能时，突然想到一个优化点：
+### 1. 不打断流地记录想法
 
-> "帮我把这个想法记到收集箱：重构用户认证模块，使用 JWT + Refresh Token 方案"
+编着编着突然想到一个优化点：
 
-AI 自动创建任务，稍后你打开看板就能看到待整理的想法。
+> "记一下：把认证模块改成 JWT + refresh token 方案"
 
-### 2. 让 AI 规划项目结构
+Agent 创建任务。你继续写代码。稍后打开看板再回顾。
 
-开始一个新项目时，直接让 AI 帮你分解：
+### 2. 让 AI 帮你搭建项目结构
 
-> "创建一个电商后台管理项目，包含商品管理、订单处理、用户权限三个模块，每个模块分解为具体的开发任务"
+开始一个新项目：
 
-AI 自动创建项目结构，你只需要在浏览器中打开看板，拖拽任务开始工作。
+> "创建一个电商后台项目，包含商品管理、订单处理、用户权限三个模块，每个模块拆分为具体任务"
 
-### 3. 进度追踪与状态更新
+Agent 直接搭好整个结构。你打开看板开始拖拽。
 
-编码过程中随时询问：
+### 3. 不离开对话窗口就能检查进度
 
-> "我当前项目完成了多少百分比？有哪些高优先级任务还没开始？"
+> "当前项目还剩什么？有没有高优先级的任务还没动？"
 
-> "把用户登录功能的状态改为已完成，并创建对应的测试任务"
+> "把登录功能标为已完成，再加一个写测试的任务"
 
-### 4. 团队协作分配
-
-在对话中快速分配：
-
-> "把前端页面的任务分配给 @张三，截止日期设为本周五，优先级设为高"
-
-团队成员可以在看板中查看自己的任务列表。
-
----
-
-## 安装
-
-### 环境要求
-
-- Node.js 18+ (推荐 20+)
-
-### 全局安装
-
-```bash
-npm install -g roadmap-skill
-```
-
-### 免安装使用
-
-```bash
-npx roadmap-skill          # 完整 MCP 服务器
-```
+不用切换标签页，不用复制粘贴。直接问就行。
 
 ---
 
@@ -337,11 +323,9 @@ npx roadmap-skill          # 完整 MCP 服务器
 
 ## 支持平台
 
-- ✅ **Claude Code** — 命令行 AI 助手
-- ✅ **Claude Desktop** — 完整 MCP 集成
-- ✅ **Cursor** — AI 驱动的 IDE
-- ✅ **VS Code** — 通过 Cline 或 Roo Code 扩展
-- ✅ **任意 MCP 客户端** — 标准 MCP 协议支持
+- ✅ **Claude Code, Codex, OpenCode** — 命令行 AI 助手
+- ✅ **Cursor, VS Code** — AI 驱动的 IDE
+- ✅ **任意支持 MCP 的客户端** — 标准 MCP 协议支持
 
 ---