Update Definitions

Definitions.md

@@ -1,48 +1,48 @@
-# Project definition and Scope
+# Project definition and Scope
-
+
-## Main idea
+## Main idea
-
+
-This project aims to extend the issue management functionality of git forges,
+This project aims to extend the issue management functionality of git forges,
-allowing more complex project management workflows and provide features not
+allowing more complex project management workflows and provide features not
-included in the forge by itself.
+included in the forge by itself.
-
+
-### What is/will be implemented:
+### What is/will be implemented:
-
+
-- [ ] view for repository and organization wide
+- [ ] view for repository and organization wide
-- [ ] Issue management via labels:
+- [ ] Issue management via labels:
-    - [ ] List view
+    - [ ] List view
-    - [ ] Kanban Board
+    - [ ] Kanban Board
-- [ ] Time tracking:
+- [ ] Time tracking:
-    - [ ] Pomodoro timmer
+    - [ ] Pomodoro timmer
-    - [ ] Flowtime timmer
+    - [ ] Flowtime timmer
-- [ ] Dependencies / blocking visualization
+- [ ] Dependencies / blocking visualization
-- [ ] Milestone management
+- [ ] Milestone management
-- [ ] Calendar via due dates
+- [ ] Calendar via due dates
-- [ ] Work session[¹] management
+- [ ] Work session[¹] management
-
+
-[¹]: How many _sessions_ (AKA sittins) this issue has done vs allows
+[¹]: Unspecified space of time dedicated exclusively to one task (issue in our case). This allow to do some sort of [time-boxing](https://en.wikipedia.org/wiki/Timeboxing) without committing to a date deadline.
-
+
-### What won't be implemented
+### What won't be implemented
-
+
-- A full jira clone
+- A full jira clone
-- Support for every git forge
+- Support for every git forge
-
+
-### Constraints
+### Constraints
-
+
-- It needs to be a stateless application:
+- It needs to be a stateless application:
-  - Data should come primary from the git forge
+  - Data should come primary from the git forge
-  - For the functionality not supported by the git forge, it needs to be stored in the frontmatter of the issue description
+  - For the functionality not supported by the git forge, it needs to be stored in the frontmatter of the issue description
-  - Configuration needs to be done via config file, env vars or command line arguments
+  - Configuration needs to be done via config file, env vars or command line arguments
-  - Data stored in the app should only be transactional and cache in an in-memory database
+  - Data stored in the app should only be transactional and cache in an in-memory database
-- It needs to be mobile friendly
+- It needs to be mobile friendly
-- It needs to have an extensible design
+- It needs to have an extensible design
-
+
-## Tech stack
+## Tech stack
-
+
-- Backend: 
+- Backend: 
-    - Go
+    - Go
-    - SQLite
+    - SQLite
-- Frontend: 
+- Frontend: 
-    - HTMX 
+    - HTMX 
-    - AlpineJS
+    - AlpineJS
-    - [CSS design system](https://git.alecodes.page/alecodes/mini-strap)
+    - [CSS design system](https://git.alecodes.page/alecodes/mini-strap)