PRD: kataba v1 #1

Closed
opened 2026-11-01 16:18:37 +01:00 by miko · 1 comment
Owner

kataba v1

Open, visual step-by-step documentation for a single organisation, inspired by Dozuki/iFixit.

Sources of truth

  • Product description: docs/project-description.md
  • Vocabulary: GLOSSARY.md — use its terms in code, issues and UI
  • Decisions: docs/adr/0001–0010

v1 scope

Categories (tree, alphabetical or manual child order), guides (draft/published, soft delete), steps with up to three 4:3 step images, annotations (rect/circle, palette colours), step lines (indent, bullet/caution/note/reminder), Editor.js content, sign-in via Auth.js + Authentik, roles (viewer/author/admin), ownership + wiki mode, visibility (public/internal, most restrictive wins), full-text search, UI in English and German via Lingui/gettext, admin settings.

Out of scope for v1

Tools/parts lists, difficulty/time, prerequisites, revisions and working copies, comments, PDF export, videos, content translation, Docker, category slug redirects, autosave.

Slices

  • #2 Clean up project scaffold
  • #3 Spike: Lingui (gettext) with Next 16, Turbopack and cacheComponents
  • #4 Sign-in with Auth.js and Authentik; roles from groups
  • #5 Admin settings page
  • #6 Categories: tree, pages and admin management
  • #7 Domain module: effective visibility and permissions
  • #8 Guides: create, read, publish, delete (text only)
  • #9 Steps: edit route and step list
  • #10 Step lines: coloured and icon list per step
  • #11 Step images: upload, crop, variants, guarded media route
  • #12 Annotation editor
  • #13 Ownership and wiki mode in the UI
  • #14 Full-text search
  • #15 End-to-end tests with Playwright
  • #16 Visual design and theme
  • #17 Selectable accent colour
  • #18 Guide cover image
# kataba v1 Open, visual step-by-step documentation for a single organisation, inspired by Dozuki/iFixit. ## Sources of truth - Product description: `docs/project-description.md` - Vocabulary: `GLOSSARY.md` — use its terms in code, issues and UI - Decisions: `docs/adr/0001`–`0010` ## v1 scope Categories (tree, alphabetical or manual child order), guides (draft/published, soft delete), steps with up to three 4:3 step images, annotations (rect/circle, palette colours), step lines (indent, bullet/caution/note/reminder), Editor.js content, sign-in via Auth.js + Authentik, roles (viewer/author/admin), ownership + wiki mode, visibility (public/internal, most restrictive wins), full-text search, UI in English and German via Lingui/gettext, admin settings. ## Out of scope for v1 Tools/parts lists, difficulty/time, prerequisites, revisions and working copies, comments, PDF export, videos, content translation, Docker, category slug redirects, autosave. ## Slices - [x] #2 Clean up project scaffold - [x] #3 Spike: Lingui (gettext) with Next 16, Turbopack and cacheComponents - [x] #4 Sign-in with Auth.js and Authentik; roles from groups - [x] #5 Admin settings page - [x] #6 Categories: tree, pages and admin management - [x] #7 Domain module: effective visibility and permissions - [x] #8 Guides: create, read, publish, delete (text only) - [x] #9 Steps: edit route and step list - [x] #10 Step lines: coloured and icon list per step - [x] #11 Step images: upload, crop, variants, guarded media route - [x] #12 Annotation editor - [x] #13 Ownership and wiki mode in the UI - [x] #14 Full-text search - [x] #15 End-to-end tests with Playwright - [x] #16 Visual design and theme - [x] #17 Selectable accent colour - [x] #18 Guide cover image
Author
Owner

All v1 slices (#2–#18) are closed. Closing the PRD.

All v1 slices (#2–#18) are closed. Closing the PRD.
miko closed this issue 2026-11-02 19:30:36 +01:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
MassiveDynamic/kataba#1
No description provided.