Onderhoud deze handleiding
De bron bevindt zich in de applicatierepository, dus een gedragsverandering en de bijbehorende
documentatie kunnen samen worden ingediend. Gegenereerde schermafbeeldingen staan in de zuster-
repository lotti-docs en worden nooit in de applicatiestructuur opgenomen.
Bewerk proza
- Bewerk of voeg het Engelse MDX-bestand toe onder
docs-site/docs. - Werk het overeenkomende bestand bij voor elke gepubliceerde landinstelling onder
docs-site/i18n/<locale>/docusaurus-plugin-content-docs/current. - Voeg een nieuwe pagina toe aan
docs-site/sidebars.ts. - Update
docs-site/metadata/features.jsonwanneer de dekking verandert. - Werk de overeenkomende vermeldingen bij
docs-site/metadata/surface-inventory.json. Een oppervlak wordt geverifieerd alleen als de huidige productie-UI, proza en screenshot-dekking dat hebben allemaal beoordeeld. - Voer
make manual_checkuit. - Bekijk de productiebuild lokaal met
make manual_serve, inclusief de taalkiezer en elke gelokaliseerde route.
Validatie vereist dat elke gepubliceerde vertaalboom dezelfde pagina bevat paths als de Engelse bronboom. Het verwerpt ook vertaalde paginateksten die zijn identiek aan het Engels, dus nieuwe pagina's kunnen niet stilletjes als onvertaald worden verzonden kopieën. De openbare Engelstalige URL's blijven ongewijzigd; andere talen zijn gepubliceerd onder hun eigen localevoorvoegsel.
Houd de dekkingsinventaris gezaghebbend
De inventaris definieert de grens van de Engelse handleiding van V1: elke Beamer-pagina, elke Instellingen V2-blad of editor, en elke belangrijke workflow die creëert of materieel verandert gegevens of transversale configuratie. Elke invoer registreert zijn eigendom bronbestand en een brontekstanker. Validatie mislukt als een van beide verdwijnt, waardoor een route- of UI-wijziging wordt gedwongen om de handmatige audit bij te werken in plaats van te vertrekken een onzichtbare muffe rij.
Dekkingsstaten hebben opzettelijk strikte betekenissen:
- Gepland betekent dat het oppervlak bekend is, maar nog steeds geen volledige dekking heeft.
- Gedocumenteerd betekent dat er bruikbaar proza bestaat, maar dat er huidige productiescreenshots zijn of een end-to-end nauwkeurigheidsbeoordeling ontbreekt nog steeds.
- Geverifieerd betekent dat de relevante functiepagina is geverifieerd en ondersteund door geregistreerde productiescreenshots.
Voer npm --prefix docs-site run coverage:complete uit voor de vrijgavepoort. Het
mislukt totdat elk geïnventariseerd oppervlak is geverifieerd; gewone incrementele handleiding
builds blijven de resterende aantallen rapporteren zonder de onderwerpgrootte te blokkeren
pleegt.
Voeg een screenshot-case toe
- Voeg een deterministisch Flutter-screenshotharnas toe of hergebruik dit.
- Registreer de casus en de vier bronafbeeldingen
docs-site/metadata/screenshot-cases.json. - Plaats voor elk een zichtbare armatuurkopie achter
manualScreenshotText(...)ondersteunde landinstelling wanneer deze nog niet wordt aangeboden door de app-lokalisatie bestanden. - Leg elke landinstelling vast in
../lotti-docs; nooit in deze repository. - Genereer en valideer het mediamanifest.
- Verwijs op elke taalpagina naar de case met
<ManualScreenshot caseId="…" alt="…" />.
Elke app-screenshot op een geschreven pagina moet ManualScreenshot gebruiken. Direct
koppelingen naar oude lotti-docs-afbeeldingen mislukken handmatige validatie omdat dit niet mogelijk is
volg de algemene Mobile/Desktop-keuze of het light/dark-thema van de handleiding.
Elke geautomatiseerde behuizing moet mobiel-licht, mobiel-donker, desktop-licht, en desktop-donkere varianten in elke gepubliceerde landinstelling. Het handmatige onderdeel kiest de bijpassende taal en het thema. Verander Mobile/Desktop op elke afbeelding werkt elke schermafbeelding onmiddellijk bij en blijft bestaan op alle pagina's en in de geopende handleiding tabbladen.
Publiceer een release
De handmatige bron wordt niet voor elke app-versie gekopieerd. De app-releasetag al
behoudt de exacte bron. CI controleert die tag en bouwt ermee
MANUAL_VERSION=<version>, en publiceert een onveranderlijke statische map. De
release dropdown is een klein manifest van die mappen.