Skip to content

Latest commit

 

History

History
23 lines (20 loc) · 2.58 KB

README.md

File metadata and controls

23 lines (20 loc) · 2.58 KB

Wonky Write — Specifications

Collaborative, Markdown-first word processor (Google Docs–like) built on super_editor, with real-time sync via Quill Delta OT over typed Serverpod streams. Read the suite specs first (architecture, commands & undo, offline & sync).

# Spec Summary
01 Overview Purpose, prioritized feature list, what's intentionally unsupported, document map
02 Document model Canonical Wonky Delta Schema v1, Markdown codec, server models, Delta ⇄ super_editor mapping
03 Sync protocol Server-authoritative OT, stream messages, client state machine, collaborative undo, permission-restricted ops
04 Editor super_editor integration and every editing feature (typing, selection, formatting, lists, code, images, tables, mentions, slash menu, clipboard, find/replace, spellcheck, …)
05 Screens, menus & toolbar Editor screen, complete menubar, toolbar, context menus, panels, dialogs, status bar, view modes, Pages/Pageless
06 Themes Theme JSON schema, presets, fonts, dark variants, super_editor & exporter mapping, theme editor
07 Import, export & print MD/TXT/HTML/DOCX import; MD/PDF/HTML/DOCX/ODT/RTF/EPUB/TXT export; page setup; pagination; print preview
08 Comments, suggestions & history Comment anchors, suggesting mode, accept/reject, version history & diffs, presence specifics
09 MCP & AI Headless write.* tools, ui.write.* bridge tools, resources, AI assistant and inline AI
10 Implementation plan Workstreams WS-W*, contracts, dependency graph, spikes, definition of done
11 Wonky Markdown The second Markdown flavor: Serverpod blog directives (callouts, details, cards, grids, buttons, arrow links, chips, numbered headings), the flavor setting, schema, codec, editing, themes and exports
12 Native table and grid cells Tables and grids as ordinary document text: cell/grid line attributes, the legacy embed upgrade, CellEdits, the 2D cell layout (super_editor SE-15), keys, commands, pagination. Supersedes the table/grid embed parts of 02, 04 §18 and 11 §2.3

Authority order when specs disagree: suite specs for cross-cutting rules → 02/03 for content and sync semantics → feature specs. Fix the disagreement in the same change that finds it.