Underhåll denna manual

Källkoden finns i applikationsarkivet, så en beteendeförändring och dess dokumentation kan landa ihop. Genererade skärmdumpar finns i syskonarkivet lotti-docs och checkas aldrig in i applikationsträdet.

Redigera prosa

1. Redigera eller lägg till den engelska MDX-filen under docs-site/docs.
2. Uppdatera matchningsfilen för varje publicerad plats under docs-site/i18n/<locale>/docusaurus-plugin-content-docs/current.
3. Lägg till en ny sida i docs-site/sidebars.ts.
4. Uppdatera docs-site/metadata/features.json när täckningen ändras.
5. Uppdatera matchande poster i docs-site/metadata/surface-inventory.json. En yta blir verifierad endast när dess nuvarande produktionsgränssnitt, prosa och skärmdumpstäckning har Alla har granskats.
6. Kör make manual_check.
7. Granska produktionsbygget lokalt med make manual_serve, inklusive Språkväljare och varje lokaliserad rutt.

Validering kräver att varje publicerat översättningsträd innehåller samma sida stigar som det engelska källträdet. Den avvisar också översatta sidtexter som är identiska med engelska, så nya sidor kan inte tyst skickas som oöversatta kopior. De offentliga engelska URL:erna förblir oförändrade; Andra språk är publicerade under sitt eget versionerade platsprefix.

Håll täckningsinventariet auktoritativt

Inventariet definierar V1:s engelska-manualgräns: varje Beamer-sida, varje Inställningar V2 blad eller editor, och alla större arbetsflöden som skapar eller material ändrar data eller tvärskärande konfiguration. Varje post registrerar sitt ägande källfil och ett källtextankare. Validering misslyckas om någon av dem försvinner, vilket tvingar fram en rutt- eller UI-ändring för att uppdatera den manuella revisionen istället för att lämna En osynlig, gammal bråk.

Täckningsstater har medvetet strikta betydelser:

• Planerad betyder att ytan är känd men fortfarande saknar fullständig täckning.
• Dokumenterat betyder att användbar prosa finns, men skärmdumpar från nuvarande produktion eller så saknas en noggrannhet från början till slut.
• Verifierad betyder att den relevanta funktionssidan är verifierad och stödd av registrerade produktionsskärmdumpar.

Kör npm --prefix docs-site run coverage:complete som utgivningsgrind. Det misslyckas tills varje inventerad yta är verifierad; vanliga inkrementella manualbyggen fortsätter att rapportera de återstående räkningarna utan att blockera ämnesändringar.

Lägg till ett skärmdumpsfall

1. Lägg till eller återanvänd en deterministisk Flutter-skärmdumpssele.
2. Registrera fallet och dess fyra källbilder i docs-site/metadata/screenshot-cases.json.
3. Lägg synlig fixturetext bakom manualScreenshotText(...) för varje språk som stöds när den inte redan tillhandahålls av applokaliseringsfilerna.
4. Fånga varje språk i ../lotti-docs, aldrig i detta arkiv.
5. Skapa och validera mediemanifestet.
6. Referera till fallet med <ManualScreenshot caseId="…" alt="…" /> på varje språksida.

Varje appskärmdump på en författad sida måste använda ManualScreenshot. Direkta länkar till gamla lotti-docs-bilder misslyckas vid manualvalidering eftersom de inte kan följa det globala Mobile/Desktop-valet eller manualens ljusa/mörka tema.

Varje automatiserat fall måste ha mobile-light-, mobile-dark-, desktop-light- och desktop-dark-varianter för varje publicerat språk. Manualkomponenten väljer det matchande språket och temat. När Mobile/Desktop ändras på en bild uppdateras alla skärmdumpar direkt, och valet bevaras mellan sidor och öppna manualflikar.

Publish a release

Manualkällan kopieras inte för varje appversion. Appens utgåvetagg bevarar redan exakt källa. CI checkar ut den taggen, bygger med MANUAL_VERSION=<version> och publicerar en oföränderlig statisk katalog. Utgåverullistan är ett litet manifest över dessa kataloger.