No description
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
red-fenix cd45b76ad4 docs: assign self and start Forgejo timer when starting a ticket
Adds self-assignment and stopwatch start/stop to the ticket workflow,
alongside the existing live-update rule, so other parallel sessions
can see who is working what and since when without reading comments.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01LoNrSy7Reyp7evkfcdHeLX
2026-09-11 11:45:29 +02:00
.agents/skills chore: add agent skills from mattpocock/skills 2026-09-11 10:51:17 +02:00
.claude/skills chore: add agent skills from mattpocock/skills 2026-09-11 10:51:17 +02:00
docs docs: remove tooling as a catalogue entity 2026-09-11 11:26:24 +02:00
.env.example chore: add gitignore and .env.example for local secrets 2026-09-11 11:03:14 +02:00
.gitignore chore: add gitignore and .env.example for local secrets 2026-09-11 11:03:14 +02:00
CLAUDE.md docs: assign self and start Forgejo timer when starting a ticket 2026-09-11 11:45:29 +02:00
skills-lock.json chore: add agent skills from mattpocock/skills 2026-09-11 10:51:17 +02:00

Polaris — documentation

design_document.md is the original reference and is kept as-is. Everything else in this folder is the working design, split by concern. Read in order the first time.

# File Answers
01 Goals & scope Why does this exist, what is in/out, how do we measure success
02 Roles & glossary Who uses it, what do the words mean
03 Scenarios & edge cases What happens, step by step, including planner triage (accept/reject + refill), cancellations, overrides, ad hoc
04 Lifecycles & hard rules State machines for job / assignment / plan, validator rules
05 Planning engine How the VRP is modelled in OR-Tools, objective, locks, re-plan policy, learning
06 UX pages Every screen, who sees it, what it does
07 Architecture Components, flows, docker compose, auth, observability
08 Data model PostgreSQL/PostGIS schema, versioning, soft delete, audit
09 API REST surface between Angular and FastAPI
10 Dev workflow Repo layout, gitflow, Conventional Commits, CI, code style
11 Roadmap Milestones and what each one proves
12 Implementation plan Bottom-up build order, parallel tracks, import rules

Decisions that are still open are collected at the bottom of each file under Open questions, and summarised in 11-roadmap.md.

Decisions that reverse an earlier documented choice are recorded as ADRs in adr/.