Underhåll denna manual

Källkoden finns i applikationsarkivet, så en beteendeförändring och dess dokumentation kan landa ihop. Genererade skärmdumpar publiceras till en Cloudflare R2-bucket under ett versionerat prefix per manualversion 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 först när dess nuvarande produktionsgränssnitt, prosa och skärmdumpstäckning alla har granskats.
6. Kör make manual_check.
7. Granska produktionsbygget lokalt med make manual_serve, inklusive språkväljaren och varje lokaliserad rutt.

Valideringen kräver att varje publicerat översättningsträd innehåller samma sidsökvägar som det engelska källträdet. Den avvisar också översatta sidtexter som är identiska med engelskan, så nya sidor kan inte tyst skickas som oöversatta kopior. De offentliga engelska URL:erna förblir oförändrade; andra språk publiceras under sitt eget versionerade språkprefix.

Håll täckningsinventariet auktoritativt

Inventariet definierar V1-gränsen för den engelska manualen: varje Beamer-sida, varje blad eller redigerare i Inställningar V2, och varje större arbetsflöde som skapar eller väsentligt ändrar data eller tvärgående konfiguration. Varje post registrerar sin ägande källfil och ett källtextankare. Valideringen misslyckas om någotdera försvinner, vilket tvingar en rutt- eller UI-ändring att uppdatera manualrevisionen i stället för att lämna en osynlig inaktuell rad.

Täckningsstatusarna har medvetet strikta betydelser:

• Planerad betyder att ytan är känd men fortfarande saknar fullständig täckning.
• Dokumenterad betyder att användbar prosa finns, men att aktuella produktionsskärmdumpar eller en fullständig korrekthetsgranskning fortfarande saknas.
• 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 utgåvegrind. Den misslyckas tills varje inventerad yta är verifierad; vanliga inkrementella manualbyggen fortsätter att rapportera de återstående antalen utan att blockera ämnesstora commits.

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 den gitignorerade lokala staging-katalogen (make manual_screenshots); CI publicerar resultatet till R2-bucketen.
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 skärmdumpsmedia — gamla lotti-docs-bilder eller själva R2-bucketen — misslyckas vid manualvalideringen 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.

Publicera en utgåva

Manualens källa kopieras inte för varje appversion. Appens release-tagg bevarar redan det exakta läget. Varje release-tagg publicerar automatiskt manualen för sin version: om manualens sidor, skärmbildstester eller demodata har ändrats sedan förra releasen bygger CI webbplatsen och tar skärmbilderna från taggen; annars återanvänder den nya versionen förra releasens snapshot. Release-snapshots skrivs aldrig över. Appen öppnar manualen för sin egen version. De tio senaste release-snapshotsen ligger kvar online, och en länk till vilken annan version som helst hamnar på den senaste releasen. Du kan också publicera en release-manual för hand med en workflow-körning som anger marknadsversionen. Versionsväljaren läser en livekatalog som skrivs vid varje driftsättning, så även äldre manualer listar de releaser som kom efter dem.