From 282e6b604d54a0d5de9f348bca55cc1d7b851eb1 Mon Sep 17 00:00:00 2001
From: MangoPig <Ronaldng1588@gmail.com>
Date: Sat, 13 Jun 2026 14:56:42 +0100
Subject: [PATCH] Feat: Documentations

Fix
---
 Documentation/CONTRIBUTING | 161 +++++++++++++++++++++++++++++++++++++
 Documentation/TODO.md      |  70 ++++++++++++++++
 README.md                  |  25 +-----
 3 files changed, 232 insertions(+), 24 deletions(-)
 create mode 100644 Documentation/CONTRIBUTING
 create mode 100644 Documentation/TODO.md

diff --git a/Documentation/CONTRIBUTING b/Documentation/CONTRIBUTING
new file mode 100644
index 0000000..10447e4
--- /dev/null
+++ b/Documentation/CONTRIBUTING
@@ -0,0 +1,161 @@
+# Contributing
+
+Thanks for contributing to Moku Work.
+
+This project is still in an early scaffold stage, so the goal is to keep changes easy to understand, easy to review, and easy to undo.
+
+## Getting Started
+
+### Project structure
+
+- `Frontend/` — SolidStart frontend workspace
+- `Backend/` — backend placeholder
+- `Proxy/` — proxy placeholder
+- `Docker/` — local Docker Compose files
+- `Env/` — local environment files
+- `Commands/` — Just command modules and entrypoints
+
+### Prerequisites
+
+Before working on the project, make sure you have:
+
+- `just`
+- Docker with `docker compose`
+- Docker Buildx
+- Node.js `>=22`
+- `pnpm@9`
+
+### Local development
+
+List available commands:
+
+```bash
+just --list --list-submodules
+```
+
+Main local development flow:
+
+```bash
+just local dev
+```
+
+This command builds the frontend development image and starts the local development stack.
+
+### Local environment
+
+Local development uses:
+
+```bash
+Env/.env.local
+```
+
+If local environment values are missing, create or update that file before starting the stack.
+
+## Commit Naming Convention
+
+Use short, clear commit messages that describe one logical change.
+
+Preferred format:
+
+```text
+Type: Short description
+```
+
+Examples:
+
+```text
+Feat: Add login page scaffold
+Fix: Resolve mobile sidebar overflow
+Refactor: Split theme helpers from app entry
+Docs: Add local development notes
+Chore: Update frontend dependencies
+```
+
+Recommended commit types:
+
+- `Feat:` — new feature or visible behavior
+- `Fix:` — bug fix
+- `Refactor:` — internal code change without behavior change
+- `Docs:` — documentation only
+- `Chore:` — maintenance, tooling, dependency, or housekeeping work
+- `Style:` — formatting or styling-only cleanup
+- `Test:` — tests added or updated
+
+### Commit message rules
+
+- Keep the subject line short and specific
+- Start with a capitalized type
+- Describe what changed, not the entire session
+- One commit should usually be explainable in one sentence
+
+Good:
+
+```text
+Feat: Add base dashboard layout
+Fix: Correct broken theme toggle import
+Docs: Document branch naming workflow
+```
+
+Bad:
+
+```text
+stuff
+more updates
+big rewrite
+misc fixes
+```
+
+## Branch Naming Convention
+
+Use branch names that make the purpose of the work obvious at a glance.
+
+Preferred format:
+
+```text
+type/short-description
+```
+
+Examples:
+
+```text
+feature/login-page
+fix/mobile-sidebar-overflow
+refactor/theme-helpers
+docs/contributing-update
+chore/frontend-dependency-updates
+rewrite/v2-foundation
+```
+
+Recommended branch types:
+
+- `feature/` — new feature work
+- `fix/` — bug fixes
+- `refactor/` — structural code changes without intended behavior changes
+- `docs/` — documentation work
+- `chore/` — maintenance or tooling updates
+- `rewrite/` — large rebuilds or architecture overhauls
+
+### Branch naming rules
+
+- Use lowercase words
+- Separate words with hyphens
+- Keep the name short but specific
+- Name the branch after the outcome, not the time spent on it
+- For larger efforts, prefer one clear branch name over vague labels like `misc` or `updates`
+
+Good:
+
+```text
+feature/auth-shell
+fix/docker-local-env-loading
+rewrite/new-routing-foundation
+```
+
+Bad:
+
+```text
+new-stuff
+work-branch
+test
+misc-updates
+```
diff --git a/Documentation/TODO.md b/Documentation/TODO.md
new file mode 100644
index 0000000..e2e137e
--- /dev/null
+++ b/Documentation/TODO.md
@@ -0,0 +1,70 @@
+# ToDo
+
+## Version 1.0.0 Roadmap
+
+### Version 0.1.0
+
+**Goal:** Barebone frontend with a real backend core.
+
+#### Architecture
+
+- [ ] Project-Structure
+- [ ] Stack-Decisions
+- [ ] Proxy
+- [ ] Dev-and-Prod-Builds
+
+#### Backend
+
+- [ ] Auth
+  - [ ] Session-Flow
+  - [ ] Login-Logout-Foundation
+  - [ ] Authentication
+- [ ] User
+  - [ ] Base-Model
+  - [ ] Base-Workspace
+    - [ ] Folders-and-Subfolders
+    - [ ] Boards
+    - [ ] Dashboard
+- [ ] Organization
+  - [ ] Base-Model
+  - [ ] Access-Rules-and-Membership
+- [ ] Workspace
+  - [ ] Folders-and-Subfolders
+- [ ] API
+
+#### Frontend
+
+- [x] Foundation
+- [x] Typography
+- [x] Icons
+- [ ] App Shell
+- [ ] Primitives
+  - [ ] Button
+  - [ ] IconButton
+  - [ ] Input
+  - [ ] Surface
+- [ ] Nav-Bar
+- [ ] Workspace-Switching
+- [ ] Workspace-Home
+
+### Version 0.2.0
+
+**Goal:** First real work surface.
+
+- [ ] Table
+- [ ] CVA
+- [ ] Storyboard
+
+### Version 0.3.0
+
+**Goal:** Documents and system hardening.
+
+- [ ] Document
+- [ ] Accessibility-Rules
+- [ ] Motion-Foundation
+
+### Version 0.4.0
+
+- [ ] Gantt-Board
+- [ ] Calendar
+- [ ] Timeline
diff --git a/README.md b/README.md
index 9f0a1f1..5a17d8c 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,4 @@
-# Moku Base
-
-Empty scaffold for a Monday-style replacement app.
-
-## Structure
-
-- `Backend/` - blank backend placeholder
-- `Commands/` - Just submodules and command entrypoints
-- `Docker/` - local compose files
-- `Env/` - local environment files
-- `Frontend/` - SolidStart bare workspace shell
-- `Proxy/` - blank proxy placeholder
-
-## Local usage
-
-```bash
-just --list --list-submodules
-```
-
-Main local flow:
-
-```bash
-just local dev
-```
+# Moku Work
 
 ## License