docs: write the README and map the build workflow
This commit is contained in:
parent
5080e9a609
commit
fa356ba5c5
3 changed files with 245 additions and 16 deletions
|
|
@ -2,7 +2,9 @@
|
|||
|
||||
Bijgehouden tijdens de bouw. Per stap: wat ik deed, waarom, wat ik heb laten
|
||||
vallen.
|
||||
|
||||
## Dag 1 - korte sessie in de avond
|
||||
|
||||
### Opzet
|
||||
|
||||
Wat ik deed:
|
||||
|
|
@ -35,6 +37,7 @@ Wat ik heb laten vallen of uitgesteld:
|
|||
- Geen apart beslisdocument. De motivering staat in de README en hier.
|
||||
|
||||
## Dag 2
|
||||
|
||||
### Spotify-koppeling
|
||||
|
||||
Wat ik deed:
|
||||
|
|
@ -227,7 +230,7 @@ Waarom:
|
|||
main landt.
|
||||
- Styling is scoped CSS per component bovenop globale design tokens
|
||||
(custom properties). Scoped omdat machine-geconverteerde componenten
|
||||
om style leakage te voorkomen, en omdat het bouwpakket al gewone CSS
|
||||
om style leakage te voorkomen, en omdat het bouwpakket al gewone CSS
|
||||
per component leverde: een utility
|
||||
framework had een rewrite plus een extra dependency gekost. De
|
||||
tokens houden het thema op 1 plek, dus het bekende scoped-CSS risico
|
||||
|
|
@ -262,7 +265,7 @@ Wat ik deed:
|
|||
gefragmenteerde chunks, error-terminaliteit, de request-caps en
|
||||
abort-races vastlegt; draait mee in CI.
|
||||
- Alle user-facing tekst uit de componenten geextraheerd naar 1 getypeerde
|
||||
messages-module (i18n-klaar zonder er nu een framework voor mee te nemen),
|
||||
messages-module (i18n-klaar zonder er nu een framework voor mee te nemen),
|
||||
alle magic numbers vervangen door
|
||||
benoemde constants met per waarde een reden (de request-caps verwijzen
|
||||
expliciet naar de backend schema-bounds), en dichtgeschreven TypeScript
|
||||
|
|
@ -275,6 +278,7 @@ Waarom:
|
|||
contractkritische randen vastzet, voordat het richting main gaat.
|
||||
|
||||
## Dag 3 - avond
|
||||
|
||||
### Live eval run
|
||||
|
||||
Wat ik deed:
|
||||
|
|
@ -397,6 +401,8 @@ Wat ik heb laten vallen of uitgesteld:
|
|||
- Byte-snapshots per pipeline-stap; de checks hierboven en de cassettes
|
||||
zijn nu het bewijs.
|
||||
|
||||
## Dag 3 - afronding
|
||||
|
||||
### Demo mode
|
||||
|
||||
Wat ik deed:
|
||||
|
|
@ -438,3 +444,31 @@ Waarom:
|
|||
|
||||
- Minder scopes vragen dan je gebruikt is netter richting de reviewer en
|
||||
richting Spotify.
|
||||
|
||||
### Documentatie
|
||||
|
||||
Wat ik deed:
|
||||
|
||||
- De README geschreven: wat het is, drie manieren om het te draaien, hoe
|
||||
de pipeline werkt, de keuzes, eerlijke performance-cijfers (eerste kaart
|
||||
20 tot 30 s, gemeten via de UI en de eval), een stukje van de
|
||||
vergelijking met kale search, en een "where to look" tabel per
|
||||
beoordelingscriterium.
|
||||
- docs/workflow.md toegevoegd: hoe ik werk. De server, Forgejo met een
|
||||
GitHub-mirror, Komodo en Caddy voor de gehoste instantie, en hoe ik
|
||||
agents inzet: implementatie parallel en goedkoop, ontwerp, review en
|
||||
verificatie serieel en bij mij.
|
||||
- De gehoste preview bouwt nu bij elke merge opnieuw vanaf main.
|
||||
|
||||
Waarom:
|
||||
|
||||
- De reviewer leest de README het eerst; die moet kort zijn en naar de
|
||||
rest wijzen in plaats van alles zelf te vertellen. En de werkwijze
|
||||
uitleggen is eerlijker dan hem laten raden waarom commits in bursts
|
||||
binnenkomen.
|
||||
|
||||
Wat ik heb laten vallen of uitgesteld:
|
||||
|
||||
- Een sneller model op de intent call (zou de wachttijd flink verlagen;
|
||||
de fabrication rate is de afweging om dan te meten) staat als vervolg
|
||||
in de README, niet gebouwd.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue