docs: split roadmap out of readme into Documentation/roadmap.md
The readme served two roles: design-decision source of truth and
work-status tracker. The status section grew into a plan the
orchestrator must navigate, so it moves to its own file with task
IDs, dependency edges, statuses, and per-item acceptance criteria.
readme.md remains authoritative for decisions (stack, formats,
workflow); workflow step 7 and AGENTS.md pointers now name
roadmap.md for status. Cross-references verified.
Also records: stale feature/epsilon-parser branch pointer (676e55e,
2 behind main) deleted locally; recreate from main when B1 starts.
This commit is contained in:
@@ -271,9 +271,11 @@ Use a test-driven-development inspired approach, specifically the following work
|
||||
5.3 Create a git commit per passing test
|
||||
5.4 Iterate for each test until they all pass
|
||||
6. Verify everything on the checklist has been completed
|
||||
7. Update roadmap
|
||||
- this file is the source of truth
|
||||
- any task that changes a decision (stack, format, workflow) updates it in the same commit
|
||||
7. Update roadmap (Documentation/roadmap.md)
|
||||
- roadmap.md tracks what is done, in flight, or planned
|
||||
- readme.md is the source of truth for design decisions: any task
|
||||
that changes a decision (stack, format, workflow) updates it in
|
||||
the same commit
|
||||
8. Provide a short list of suggestions for improvements and include a suggested global next step
|
||||
|
||||
### General guidelines for AI
|
||||
@@ -296,42 +298,13 @@ Use a test-driven-development inspired approach, specifically the following work
|
||||
- Be concise
|
||||
|
||||
## Roadmap and status of functionality
|
||||
### Active
|
||||
* core/config — done (loading, resolution, defaults, masking, validation;
|
||||
tests green, commit 9452962)
|
||||
### In development
|
||||
* core/db — tests committed and RED (connection URL, migration splitting,
|
||||
embedded schema v1, backup/restore; commit 676e55e). Next step: minimal
|
||||
implementation until green; do not alter the tests' intent.
|
||||
* cli
|
||||
* command structure specified in Documentation/cli.md
|
||||
* ingest tab-separated .txt files containing transactions from automated gas station into a MariaDB
|
||||
* feature branch feature/epsilon-parser is open but empty: no
|
||||
spec/checklist yet (workflow step 2 pending); sanitized
|
||||
fixtures are ready (data/fixtures/epsilon)
|
||||
* create invoices from data in database
|
||||
### Future / planned
|
||||
* cli
|
||||
* ingest xlsx files containing car rental transactions exported from tsdrms
|
||||
* prepare bookkeeping voucher to be entered into Fortnox accounting/bookkeeping software suite
|
||||
* ingest pdf files containing monthly settlement data from Enterprise
|
||||
* spa
|
||||
* website for car rental firms to check details regarding invoices
|
||||
* receipt reissue for retail fuel sales (low priority)
|
||||
* customer requests a receipt for a past fuel purchase (forgot to take it, or a printing issue)
|
||||
* identifies the transaction by date + last 4 digits of the card number
|
||||
* consumer cards are stored masked (e.g. `549543******5778`), so the last 4 digits are available for lookup
|
||||
* creates a new receipt from a template
|
||||
* sends it to the customer by e-mail
|
||||
* to-do-application for employees
|
||||
* car registry for RPN
|
||||
* cars directly owned
|
||||
* leased cars
|
||||
* keeps track of costs associated with each car
|
||||
* keeps track of yearly car inspections (besiktning)
|
||||
* keeps track of general car status
|
||||
* winter or summer tyres
|
||||
* active, broken, being repaired (i.e. general status)
|
||||
|
||||
The roadmap lives in Documentation/roadmap.md: per-item status (done /
|
||||
red / spec / idea), dependencies, acceptance criteria, and near-term
|
||||
ordering. Workflow step 7 updates that file; this document remains the
|
||||
source of truth for design decisions (stack, formats, workflow) —
|
||||
a task that changes a decision updates readme.md, a task that changes
|
||||
*what is built next* updates roadmap.md.
|
||||
|
||||
## Glossary
|
||||
- aktiebolag: limited company
|
||||
|
||||
Reference in New Issue
Block a user