Improve and fix documentation

Author: asaaki

.cargo/config.toml

@@ -0,0 +1,2 @@
+[alias]
+fixit = "clippy --fix --allow-dirty --allow-staged"

README.md

@@ -8,7 +8,7 @@ Inspired by [beans](https://github.com/hmans/beans) and [beads](https://github.c
 
 ## Features
 
-- **Flat-file storage**: Issues stored as markdown with YAML frontmatter in `.peas/`
+- **Flat-file storage**: Issues stored as markdown with TOML frontmatter in `.peas/`
 - **GraphQL interface**: Query and mutate peas with GraphQL for AI agent integration
 - **Interactive TUI**: Browse and manage peas in a terminal UI
 - **Hierarchical structure**: Milestones, epics, features, bugs, and tasks
@@ -146,20 +146,25 @@ Or add to your `AGENTS.md`:
 
 | Key | Action |
 |-----|--------|
-| `j`/`k` or arrows | Navigate up/down |
-| `Tab` | Next filter |
-| `Shift+Tab` | Previous filter |
+| `↑`/`↓` | Navigate up/down |
+| `←`/`→` | Previous/next page |
+| `Tab` | Switch between Tickets/Memory views |
 | `/` | Search |
-| `Space` | Toggle status |
-| `s` | Start (set in-progress) |
-| `d` | Done (set completed) |
+| `Enter` | Open detail view |
+| `Space` | Multi-select toggle |
+| `c` | Create new ticket |
+| `s` | Change status |
+| `t` | Change type |
+| `P` | Change priority |
+| `e` | Edit in $EDITOR |
 | `r` | Refresh |
+| `u` | Undo last operation |
 | `?` | Help |
 | `q` | Quit |
 
 ## Configuration
 
-peas uses `.peas.toml` for configuration (also supports `.peas.yml`, `.peas.yaml`, or `.peas.json`):
+peas uses `.peas.toml` for configuration (also supports `.peas.yml`, `.peas.yaml`, or `.peas.json`, but TOML is preferred):
 
 ```toml
 [peas]
@@ -168,30 +173,28 @@ prefix = "peas-"        # ID prefix
 id_length = 5           # Random ID length
 default_status = "todo"
 default_type = "task"
-frontmatter = "toml"    # Frontmatter format: toml, yaml
+frontmatter = "toml"    # Frontmatter format: toml, yaml, json (TOML preferred)
 
 [tui]
 use_type_emojis = false # Enable emoji icons for ticket types in TUI
 ```
 
 ## File Format
 
-Peas are stored as markdown files with YAML frontmatter:
+Peas are stored as markdown files with TOML frontmatter (YAML and JSON also supported):
 
 ```markdown
----
-id: peas-abc1
-title: Implement feature X
-type: feature
-status: in-progress
-priority: high
-tags:
-  - backend
-  - api
-parent: peas-xyz9
-created: 2024-01-15T10:30:00Z
-updated: 2024-01-15T14:22:00Z
----
++++
+id = "peas-abc1"
+title = "Implement feature X"
+type = "feature"
+status = "in-progress"
+priority = "high"
+tags = ["backend", "api"]
+parent = "peas-xyz9"
+created = "2024-01-15T10:30:00Z"
+updated = "2024-01-15T14:22:00Z"
++++
 
 Detailed description of the feature goes here.
 

src/cli/commands.rs

@@ -13,7 +13,7 @@ pub struct Cli {
     #[command(subcommand)]
     pub command: Commands,
 
-    /// Path to config file (searches upward for .peas.yml by default)
+    /// Path to config file (searches upward for .peas.toml by default)
     #[arg(long, global = true)]
     pub config: Option<String>,
 

src/lib.rs

@@ -1,6 +1,6 @@
 //! # Peas - A CLI-based, flat-file issue tracker
 //!
-//! Peas is a lightweight issue tracker that stores issues as markdown files with YAML frontmatter.
+//! Peas is a lightweight issue tracker that stores issues as markdown files with TOML frontmatter.
 //! It provides a CLI interface for humans and a GraphQL API for AI agents and automation.
 //!
 //! ## Features
@@ -45,7 +45,7 @@ pub mod cli;
 
 /// Configuration loading and management.
 ///
-/// Handles `.peas.yml` configuration files and project discovery.
+/// Handles `.peas.toml` configuration files and project discovery.
 pub mod config;
 
 /// Error types and result aliases.
@@ -65,7 +65,7 @@ pub mod model;
 
 /// File-based storage layer.
 ///
-/// Handles reading/writing peas as markdown files with YAML frontmatter.
+/// Handles reading/writing peas as markdown files with TOML frontmatter.
 pub mod storage;
 
 /// Terminal user interface.

src/storage/markdown.rs

@@ -81,9 +81,9 @@ pub fn parse_markdown_with_format(content: &str, format: FrontmatterFormat) -> R
     Ok(pea)
 }
 
-/// Renders a pea to markdown with YAML frontmatter (default).
+/// Renders a pea to markdown with TOML frontmatter (default).
 pub fn render_markdown(pea: &Pea) -> Result<String> {
-    render_markdown_with_format(pea, FrontmatterFormat::Yaml)
+    render_markdown_with_format(pea, FrontmatterFormat::Toml)
 }
 
 /// Renders a pea to markdown with the specified frontmatter format.
@@ -274,7 +274,7 @@ This is a TOML frontmatter body.
         )
         .with_body("Task description here.".to_string());
 
-        let rendered = render_markdown(&pea).unwrap();
+        let rendered = render_markdown_with_format(&pea, FrontmatterFormat::Yaml).unwrap();
         assert!(rendered.starts_with("---\n"));
         assert!(rendered.contains("id: peas-xyz9"));
         assert!(rendered.contains("title: My Task"));

src/storage/mod.rs

@@ -1,20 +1,20 @@
 //! File-based storage layer for peas.
 //!
-//! Peas are stored as markdown files with YAML frontmatter in the `.peas/` directory.
+//! Peas are stored as markdown files with TOML frontmatter in the `.peas/` directory.
 //!
 //! ## File Format
 //!
 //! ```markdown
-//! ---
-//! id: peas-1234
-//! title: Fix login bug
-//! type: bug
-//! status: in-progress
-//! priority: high
-//! tags: [auth, urgent]
-//! created: 2024-01-15T10:30:00Z
-//! updated: 2024-01-15T14:20:00Z
-//! ---
+//! +++
+//! id = "peas-1234"
+//! title = "Fix login bug"
+//! type = "bug"
+//! status = "in-progress"
+//! priority = "high"
+//! tags = ["auth", "urgent"]
+//! created = "2024-01-15T10:30:00Z"
+//! updated = "2024-01-15T14:20:00Z"
+//! +++
 //!
 //! Description of the bug and any additional notes.
 //! ```

src/tui/mod.rs

@@ -10,13 +10,19 @@
 //!
 //! ## Keybindings
 //!
-//! - `j/k` or `↓/↑`: Navigate list
-//! - `Tab`: Cycle filters (All, Open, In Progress, etc.)
+//! - `↑/↓`: Navigate up/down
+//! - `←/→`: Previous/next page
+//! - `Tab`: Switch between Tickets/Memory views
 //! - `/`: Search
-//! - `Enter/Space`: Toggle status
-//! - `s`: Start (mark in-progress)
-//! - `d`: Done (mark completed)
+//! - `Enter`: Open detail view
+//! - `Space`: Multi-select toggle
+//! - `c`: Create new ticket
+//! - `s`: Change status
+//! - `t`: Change type
+//! - `P`: Change priority
+//! - `e`: Edit in $EDITOR
 //! - `r`: Refresh
+//! - `u`: Undo last operation
 //! - `?`: Help
 //! - `q`: Quit