Fix Phase 1 documentation issues in PLAN.md

- Add 'list create' command to features and CLI examples
- Clarify that task titles exclude .md extension in filenames
- Change deliverables from  to - [ ] for consistency with feature checklists
This commit is contained in:
Claude 2025-11-04 17:12:40 +00:00
parent 63b7a8fb60
commit 32ad78ca86
No known key found for this signature in database

80
PLAN.md
View file

@ -80,7 +80,7 @@ Task description and notes go here in **markdown** format.
```rust ```rust
Task { Task {
id: Uuid, id: Uuid,
title: String, // Derived from filename title: String, // Derived from filename (without .md extension)
description: String, // Markdown content description: String, // Markdown content
status: TaskStatus, // Backlog or Completed status: TaskStatus, // Backlog or Completed
due_date: Option<DateTime>, due_date: Option<DateTime>,
@ -120,14 +120,16 @@ WorkspaceConfig {
├── .metadata.json # Global: list ordering, last opened list ├── .metadata.json # Global: list ordering, last opened list
├── My Tasks/ # Task list folder ├── My Tasks/ # Task list folder
│ ├── .listdata.json # List metadata: task order, id, timestamps │ ├── .listdata.json # List metadata: task order, id, timestamps
│ ├── Buy groceries.md │ ├── Buy groceries.md # Title: "Buy groceries" (without .md)
│ └── Call dentist.md │ └── Call dentist.md # Title: "Call dentist" (without .md)
└── Work/ # Another task list └── Work/ # Another task list
├── .listdata.json ├── .listdata.json
├── Review PRs.md ├── Review PRs.md # Title: "Review PRs" (without .md)
└── Team meeting prep.md └── Team meeting prep.md # Title: "Team meeting prep" (without .md)
``` ```
**Note**: Task titles are derived from filenames by removing the `.md` extension.
**`.metadata.json` (root level)**: **`.metadata.json` (root level)**:
```json ```json
{ {
@ -291,8 +293,9 @@ tokio = { workspace = true }
- [ ] CLI: `workspace remove` command (delete workspace) - [ ] CLI: `workspace remove` command (delete workspace)
- [ ] CLI: `workspace retarget` command (update workspace path without moving files) - [ ] CLI: `workspace retarget` command (update workspace path without moving files)
- [ ] CLI: `workspace migrate` command (move files to new location) - [ ] CLI: `workspace migrate` command (move files to new location)
- [ ] CLI: `add` command (create tasks) - [ ] CLI: `list create` command (create new task lists)
- [ ] CLI: `list` command (view tasks) - [ ] CLI: `list` command (view tasks)
- [ ] CLI: `add` command (create tasks)
- [ ] CLI: `complete` command (mark done) - [ ] CLI: `complete` command (mark done)
- [ ] CLI: `delete` command (remove tasks) - [ ] CLI: `delete` command (remove tasks)
- [ ] CLI: `edit` command (modify tasks - CLI only, creates temp file) - [ ] CLI: `edit` command (modify tasks - CLI only, creates temp file)
@ -324,6 +327,13 @@ $ bevy-tasks workspace list
$ bevy-tasks workspace switch shared $ bevy-tasks workspace switch shared
✓ Switched to workspace "shared" ✓ Switched to workspace "shared"
# Create a new task list
$ bevy-tasks list create "Work"
✓ Created list "Work"
$ bevy-tasks list create "Personal Projects"
✓ Created list "Personal Projects"
# Add tasks (uses current workspace by default) # Add tasks (uses current workspace by default)
$ bevy-tasks add "Buy groceries" $ bevy-tasks add "Buy groceries"
✓ Created task "Buy groceries" (550e8400-e29b-41d4-a716-446655440000) ✓ Created task "Buy groceries" (550e8400-e29b-41d4-a716-446655440000)
@ -404,11 +414,11 @@ $ bevy-tasks group disable --list "Personal"
### Deliverables ### Deliverables
- `bevy-tasks-core` library with stable API - [ ] `bevy-tasks-core` library with stable API
- Functional CLI that can manage tasks - [ ] Functional CLI that can manage tasks
- Data persists as Obsidian-compatible .md files - [ ] Data persists as Obsidian-compatible .md files
- Well-tested backend (>80% coverage) - [ ] Well-tested backend (>80% coverage)
- Documentation for core library API - [ ] Documentation for core library API
### Development Setup ### Development Setup
@ -569,10 +579,10 @@ Workspace: shared
### Deliverables ### Deliverables
- Working WebDAV sync in backend - [ ] Working WebDAV sync in backend
- CLI can sync with remote WebDAV server - [ ] CLI can sync with remote WebDAV server
- Reliable conflict resolution - [ ] Reliable conflict resolution
- Tested with Nextcloud, ownCloud - [ ] Tested with Nextcloud, ownCloud
--- ---
@ -706,10 +716,10 @@ egui = "0.31" # Core egui library
### Deliverables ### Deliverables
- Functional desktop GUI app - [ ] Functional desktop GUI app
- Sub-200ms startup time - [ ] Sub-200ms startup time
- Clean, minimal UI - [ ] Clean, minimal UI
- Feature parity with CLI - [ ] Feature parity with CLI
### Build & Release ### Build & Release
@ -791,11 +801,11 @@ mod android {
### Deliverables ### Deliverables
- App launches on iOS - [ ] App launches on iOS
- App launches on Android - [ ] App launches on Android
- Can create and view tasks on mobile - [ ] Can create and view tasks on mobile
- Validates cross-platform architecture - [ ] Validates cross-platform architecture
- Foundation for future mobile polish - [ ] Foundation for future mobile polish
### Distribution ### Distribution
@ -836,10 +846,10 @@ mod android {
### Deliverables ### Deliverables
- Full-featured task manager on all platforms - [ ] Full-featured task manager on all platforms
- Polished UX on desktop - [ ] Polished UX on desktop
- Touch-optimized UX on mobile - [ ] Touch-optimized UX on mobile
- Consistent feature set across platforms - [ ] Consistent feature set across platforms
--- ---
@ -876,9 +886,9 @@ mod android {
### Deliverables ### Deliverables
- Native-feeling mobile apps - [ ] Native-feeling mobile apps
- Deep platform integration - [ ] Deep platform integration
- Mobile-specific features - [ ] Mobile-specific features
### Distribution ### Distribution
@ -945,10 +955,10 @@ If you want game-like polish after Phase 7:
### Deliverables ### Deliverables
- Polished, delightful UX - [ ] Polished, delightful UX
- Unique features not in Google Tasks - [ ] Unique features not in Google Tasks
- Easy migration path from Google Tasks - [ ] Easy migration path from Google Tasks
- Distribution to all app stores - [ ] Distribution to all app stores
### Final Distribution ### Final Distribution