Skip to content

Commit 351a8f0

Browse files
committed
docs(BAT-8): refresh README, add USAGE, screenshots, and docs skill
- Expand README with full command table, links to English/Turkish guides, board screenshot - Add docs/USAGE.md mirroring KULLANIM; update KULLANIM (tw back, keys, :, Esc, TASKWAL_DIR fix) - Add docs/images board/stats PNGs via scripts/generate_doc_screenshots.py (Pillow) - Add .cursor/skills/taskwal-project-docs for keeping docs in sync; gitignore .docgen_pillow Made-with: Cursor
1 parent 2a23dc8 commit 351a8f0

8 files changed

Lines changed: 445 additions & 13 deletions

File tree

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: taskwal-project-docs
3+
description: Maintains TaskWAL user-facing documentation in English and Turkish and TUI screenshots when the CLI, board, or on-disk layout changes. Use when editing src/, adding or changing tw subcommands or TUI behavior, updating README or docs, or when the user asks to sync or refresh project documentation.
4+
---
5+
6+
# TaskWAL project documentation
7+
8+
## Files to keep aligned
9+
10+
| Asset | Role |
11+
| ----- | ---- |
12+
| [README.md](../../../README.md) | Short overview, quick reference, links to full guides |
13+
| [docs/USAGE.md](../../../docs/USAGE.md) | Full English user guide |
14+
| [docs/KULLANIM.md](../../../docs/KULLANIM.md) | Full Turkish user guide (mirror of USAGE) |
15+
| [docs/images/](../../../docs/images/) | `board.png`, `stats.png` for README and guides |
16+
17+
## When to update
18+
19+
1. **CLI change** (`src/main.rs`, `src/commands.rs`): reflect new/changed subcommands, flags, or id rules in README (table or examples), then **both** USAGE and KULLANIM.
20+
2. **TUI change** (`src/ui/`): update keyboard tables, command-line (`:`) behavior, and **refresh screenshots** if the visible layout or colors change materially.
21+
3. **Data paths / env**: keep README, USAGE, and KULLANIM consistent (`TASKWAL_DIR`, WAL path).
22+
4. **Analytics text** (`tw stats` output vs stats screen): keep USAGE/KULLANIM descriptions in sync with `src/` and [src/ui/stats.rs](../../../src/ui/stats.rs).
23+
24+
## Screenshots
25+
26+
- Regenerate stylized PNGs after meaningful UI changes:
27+
28+
```bash
29+
pip install --target .docgen_pillow pillow # once; .docgen_pillow is gitignored
30+
PYTHONPATH=.docgen_pillow python3 scripts/generate_doc_screenshots.py
31+
```
32+
33+
- Commit updated files under `docs/images/`. The script draws an approximation of the TUI; replace with real terminal captures if you need pixel-perfect fidelity.
34+
35+
## Checklist
36+
37+
- [ ] README links to USAGE and KULLANIM
38+
- [ ] English and Turkish guides describe the same commands and keys
39+
- [ ] Image paths in markdown use `images/...` from `docs/*.md` and `docs/images/...` from README root
40+
- [ ] No drive-by edits to unrelated markdown

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
/target
22
**/*.rs.bk
33
.DS_Store
4+
.docgen_pillow/

README.md

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Local-first task tracker using an append-only JSONL write-ahead log (`~/.taskwal/wal.log` on Unix, `%USERPROFILE%\.taskwal\wal.log` on Windows).
44

5+
![TaskWAL board (TUI)](docs/images/board.png)
6+
57
## Build
68

79
Requires [Rust](https://rustup.rs/) 1.70+.
@@ -13,33 +15,58 @@ cargo build --release
1315

1416
## Cross-platform
1517

16-
- **macOS / Linux / Windows**: the same codebase; `crossterm` + `ratatui` work on common terminals.
18+
- **macOS / Linux / Windows:** same codebase; `crossterm` + `ratatui` work on common terminals.
1719
- Build on each OS you ship for, or use cross-compilation (e.g. `cargo build --release --target x86_64-pc-windows-gnu` from a configured toolchain).
1820

19-
## Usage
21+
## Documentation
22+
23+
- **English (full guide):** [docs/USAGE.md](docs/USAGE.md)
24+
- **Türkçe (tam kılavuz):** [docs/KULLANIM.md](docs/KULLANIM.md)
2025

21-
Türkçe ayrıntılı kılavuz: [docs/KULLANIM.md](docs/KULLANIM.md).
26+
## Usage (quick reference)
2227

2328
```bash
2429
tw add "Write API" --tag backend
25-
tw start 01HX… # prefix match if unique
30+
tw start 01HX… # prefix match if unique
2631
tw done 01HX…
32+
tw back 01HX… # one step back: Done→Doing or Doing→Todo
33+
tw edit 01HX… "New title"
34+
tw note 01HX… "Blocked on API"
35+
tw rm 01HX…
36+
2737
tw ls # Todo/Doing: all open tasks; Done: today (local) by default
2838
tw ls --all # Done column: all completed tasks
2939
tw ls --date 2026-04-01
30-
tw stats
31-
tw board
40+
41+
tw board # interactive Kanban TUI (same view flags as ls)
42+
tw stats # aggregate stats (all-time), text output
3243
tw log # raw WAL JSON lines
3344
```
3445

46+
### Commands
47+
48+
| Command | Purpose |
49+
|--------|---------|
50+
| `add <title>` | New task (Todo); `--tag` / `-t` comma-separated tags |
51+
| `start <id>` | Move to Doing |
52+
| `done <id>` | Move to Done |
53+
| `back <id>` | Move one column backward |
54+
| `edit <id> <title>` | Rename task |
55+
| `note <id> <text>` | Append a note |
56+
| `rm <id>` | Remove task (append-only delete event in WAL) |
57+
| `ls` | Print board columns for the current view (`--all`, `--date`) |
58+
| `board` | Full-screen TUI board (`--all`, `--date`) |
59+
| `stats` | Print statistics |
60+
| `log` | Dump WAL as JSON lines |
61+
3562
### Daily view rules
3663

37-
- **Todo / Doing:** every open task is listed (carry-over across days; nothing unfinished disappears from the default view).
64+
- **Todo / Doing:** every open task is listed (carry-over across days).
3865
- **Done:** by default, tasks completed on **today’s local calendar date**. Use `--all` or `--date` to widen.
3966

4067
## Environment
4168

42-
- **`TASKWAL_DIR`**: override the data directory (used by tests and for custom locations). WAL file: `$TASKWAL_DIR/wal.log`.
69+
- **`TASKWAL_DIR`:** override the data directory (used by tests and for custom locations). WAL file: `$TASKWAL_DIR/wal.log`.
4370

4471
## License
4572

docs/KULLANIM.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Bu belge, projenin **mevcut sürümü** için komut satırı ve TUI kullanımını anlatır.
44

5+
İngilizce aynı seviyede kılavuz: [USAGE.md](USAGE.md).
6+
57
## Uygulama nedir?
68

79
TaskWAL, görevlerinizi **yerel bilgisayarınızda** tutan bir iş takip aracıdır. Tüm değişiklikler, silme dahil, **append-only** bir günlük dosyasına (WAL) yazılır; uygulama bu dosyayı okuyup güncel pano (Todo / Doing / Done) durumunu **yeniden oynatarak** (replay) üretir.
@@ -17,7 +19,7 @@ TaskWAL, görevlerinizi **yerel bilgisayarınızda** tutan bir iş takip aracıd
1719

1820
Özel konum için ortam değişkeni:
1921

20-
- `**TASKWAL_DIR`**: Veri klasörü. WAL yolu: `$TASKWAL_DIR/wal.log` (Windows’ta `%TASKWAL_DIR%\wal.log`).
22+
- **`TASKWAL_DIR`**: Veri klasörü. WAL yolu: `$TASKWAL_DIR/wal.log` (Windows’ta `%TASKWAL_DIR%\wal.log`).
2123

2224
## Kurulum ve `tw` komutu
2325

@@ -51,8 +53,8 @@ tw <komut> --help
5153
**Done** kolonu:
5254

5355
- **Varsayılan:** Yerel saat diliminde **seçilen takvim gününde** tamamlanan görevler. Seçim belirtilmezse gün = **bugün**.
54-
- `**--all`:** Tamamlanan **tüm** görevler (geçmiş dahil); Todo/Doing yine tüm açık işlerdir.
55-
- `**--date YYYY-MM-DD`:** Done kolonu yalnızca o yerel güne düşen tamamlamalara göre süzülür.
56+
- **`--all`:** Tamamlanan **tüm** görevler (geçmiş dahil); Todo/Doing yine tüm açık işlerdir.
57+
- **`--date YYYY-MM-DD`:** Done kolonu yalnızca o yerel güne düşen tamamlamalara göre süzülür.
5658

5759
`--all` ile `--date` **birlikte kullanılamaz.**
5860

@@ -69,7 +71,7 @@ tw add "API taslağını yaz"
6971
tw add "Review" --tag backend,urgent
7072
```
7173

72-
- `**--tag` / `-t`:** Virgülle ayrılmış etiket listesi.
74+
- **`--tag` / `-t`:** Virgülle ayrılmış etiket listesi.
7375

7476
### `tw start <id>`
7577

@@ -79,6 +81,10 @@ Görevi **Doing** kolonuna taşır. İlk kez Doing’e geçişte “başlangıç
7981

8082
Görevi **Done** kolonuna taşır; tamamlanma zamanı kaydedilir.
8183

84+
### `tw back <id>`
85+
86+
Görevi **bir kolon geri** alır: Done → Doing → Todo (uygun olduğunda).
87+
8288
### `tw edit <id> <yeni başlık>`
8389

8490
Başlığı günceller.
@@ -115,6 +121,10 @@ tw board --all
115121
tw board --date 2026-04-01
116122
```
117123

124+
![Board TUI](images/board.png)
125+
126+
**Seçili kolon** kenarlığı vurgulanır. **Seçili satır** açık ve koyu temalarda okunaklı görünsün diye **turuncu** arka plan ve kalın yazı ile gösterilir.
127+
118128
**Klavye (board ekranı):**
119129

120130

@@ -124,10 +134,14 @@ tw board --date 2026-04-01
124134
| `` / `` | Seçili kolonda satır |
125135
| `s` | Seçili görevi Doing’e al |
126136
| `d` | Seçili görevi Done’a al |
137+
| `b` | Seçili görevi bir kolon geri al (Done→Doing→Todo) |
127138
| `a` | Done kolonu: bugünün tamamlananları ↔ tüm tamamlananlar arasında geçiş |
128139
| `g` | İstatistik ekranına geç |
129140
| `q` | Çıkış |
141+
| `:` | Komut satırı (aşağıya bakın) |
142+
| `Esc` | Komut satırında iptal |
130143

144+
**Komut satırı (`:`):** Örneğin `add Yeni görev` veya `start 01ABC123` yazın (`tw` öneki isteğe bağlı). **Enter** ile çalıştırın, **Esc** ile iptal.
131145

132146
**İstatistik ekranı:**
133147

@@ -149,7 +163,11 @@ Yeni görev **CLI** ile eklenir: `tw add "…"`.
149163
- Ortalama **lead** süresi (gün): oluşturma → tamamlanma
150164
- Aktif gün başına düşen ortalama tamamlanan iş
151165
- Yerel günlere göre **streak** (ardışık günler)
152-
- Son günlerin kısa dökümü
166+
- Son günlerin kısa dökümü
167+
168+
`tw board` içindeki tam ekran istatistik görünümü:
169+
170+
![İstatistik ekranı](images/stats.png)
153171

154172
### `tw log`
155173

0 commit comments

Comments
 (0)