Marlin/docs/roadmap.md

Marlin ― Delivery Road‑map v3

Engineering‑ready version — updated 2025‑05‑17

Legend △ = engineering artefact (spec / ADR / perf target)  ✦ = user-visible deliverable

---

0 · Methodology primer (what “Done” means)

Theme	Project rule-of-thumb
Branching	Trunk-based. Feature branches → PR → 2 reviews → squash-merge.
Spec first	Every epic starts with a Design Proposal (DP-xxx) in /docs/adr/. Include schema diffs, example CLI session, perf budget.
Tests	Unit + integration coverage ≥ 85 % on lines touched in the sprint (checked by Tarpaulin).
Perf gate	Cold start P95 ≤ 3 s on 100 k files unless overridden in DP. Regressions fail CI.
Docs	CLI flags & examples land in README.md same PR that ships the code.
Demo	Closing each epic produces a 2-min asciinema or gif in docs/demos/.

---

1 · Bird’s‑eye table (now includes engineering columns)

Phase / Sprint	Timeline	Focus & Rationale	✦ Key UX Deliverables	△ Engineering artefacts / tasks	Definition of Done
Epic 1 — Scale & Reliability	2025-Q2	Stay fast @ 100 k files	• scan --dirty (re-index touched rows only)	• DP-002 Dirty-flag design + FTS rebuild cadence • Hyperfine benchmark script committed	Dirty scan vs full ≤ 15 % runtime on 100 k corpus; benchmark job passes
Epic 2 — Live Mode & Self‑Pruning Backups	2025-Q2	“Just works” indexing, DB never explodes	• marlin watch <dir> (notify/FSEvents) • backup --prune N & auto-prune	• DP-003 file-watcher life-cycle & debouncing • Integration test with inotify-sim • Cron-style GitHub job for nightly prune	8 h stress-watch alters 10 k files < 1 % misses; backup dir ≤ N
Phase 3 — Content FTS + Annotations	2025-Q3	Search inside files, leave notes	• Grep-style snippet output (-C3) • marlin annotate add/list	• DP-004 content-blob strategy (inline vs ext-table) • Syntax-highlight via syntect PoC • New FTS triggers unit-tested	Indexes 1 GB corpus in ≤ 30 min; snippet CLI passes golden-file tests
Phase 4 — Versioning & Deduplication	2025-Q3	Historic diffs, detect dupes	• scan --rehash (SHA-256) • version diff <file>	• DP-005 hash column + Bloom-de-dupe • Binary diff adapter research	Diff on 10 MB file ≤ 500 ms; dupes listed via CLI
Phase 5 — Tag Aliases & Semantic Booster	2025-Q3	Tame tag sprawl, start AI hints	• tag alias add/ls/rm • tag suggest, summary	• DP-006 embeddings size & model choice • Vector store schema + k-NN index bench	95 % of “foo/bar~foo” alias look-ups resolve in one hop; suggest CLI returns ≤ 150 ms
Phase 6 — Search DSL v2 & Smart Views	2025-Q4	Pro-grade query language	• New nom grammar: AND/OR, parentheses, ranges	• DP-007 BNF + 30 acceptance strings • Lexer fuzz-tests with cargo-fuzz	Old queries keep working (migration shim); 0 crashes in fuzz run ≥ 1 M cases
Phase 7 — Structured Workflows	2025-Q4	Tasks, state, reminders, templates	• state set/transitions add/log • task scan/list • NEW: template apply	• DP-008 Workflow tables & validation • Sample YAML template spec + CLI expansion tests	Create template, apply to 20 files → all attrs/link rows present; state graph denies illegal transitions
Phase 8 — Lightweight Integrations	2026-Q1	First “shell” GUIs	• VS Code side-bar (read-only) • TUI v1 (tag tree ▸ file list ▸ preview)	• DP-009 TUI key-map & redraw budget • Crate split marlin_core, marlin_tui	TUI binary ≤ 2.0 MB; 10 k row scroll ≤ 4 ms redraw
Phase 9 — Dolphin Sidebar (MVP)	2026-Q1	Peek metadata in KDE file-manager	• Qt-plugin showing tags, attrs, links	• DP-010 DB/IP bridge (D‑Bus vs UNIX socket) • CMake packaging script	Sidebar opens in ≤ 150 ms; passes KDE lint
Phase 10 — Full GUI & Multi-device Sync	2026-Q2	Edit metadata visually, sync option	• Electron/Qt hybrid explorer UI • Pick & integrate sync backend	• DP-011 sync back-end trade-study • UI e2e tests in Playwright	Round-trip CRUD between two nodes in < 2 s; 25 GUI tests green

---

2 · Feature cross-matrix (quick look-ups)

Capability	Sprint / Phase	CLI flag or GUI element	Linked DP
Relationship templates	P7	template new, template apply	DP-008
Positive / negative filter combinator	P6	DSL +tag:foo -tag:bar date>=2025	DP-007
Dirty-scan optimisation	E1	scan --dirty	DP-002
Watch-mode	E2	marlin watch .	DP-003
Grep snippets	P3	search -C3 "foo"	DP-004
Hash / dedupe	P4	scan --rehash	DP-005

---

3 · Milestone acceptance checklist

Before a milestone is declared “shipped”:

• Spec merged (DP-xxx) with schema diff & example ASCII-cast
• Unit & integration tests ≥ 85 % coverage on changed lines
• Perf guard-rail script passes on CI matrix (Ubuntu 22, macOS 14)
• Docs — CLI man-page, README table row, roadmap ticked
• Demo uploaded to docs/demos/ and linked in release notes
• Release tag pushed; Cargo binary on GitHub Releases

---

4 · Next immediate actions

1. Write DP-001 (Schema v1.1) — owner @alice, due 21 May
2. Set up Tarpaulin & Hyperfine jobs — @bob, due 23 May
3. Spike dirty-flag logic — @carol 2 days time-box, outcome in DP-002

---

This roadmap now contains both product-level “what” and engineering-level “how/when/prove it”. It should allow a new contributor to jump in, pick the matching DP, and know exactly the bar they must clear for their code to merge.