Hop til hovedindhold

Vedligehold denne manual

Kildekoden ligger i applikationsarkivet, så en adfærdsændring og dens dokumentation kan lande sammen. Genererede skærmbilleder ligger i søsterarkivet lotti-docs og bliver aldrig commit'et til applikationstræet.

Rediger prosaen

  1. Rediger eller tilføj den engelske MDX-fil under docs-site/docs.
  2. Opdater matchfilen for hver publiceret lokation under docs-site/i18n/<locale>/docusaurus-plugin-content-docs/current.
  3. Tilføj en ny side til docs-site/sidebars.ts.
  4. Opdater docs-site/metadata/features.json, når dækningen ændres.
  5. Opdater match-indgangene i docs-site/metadata/surface-inventory.json. En flade bliver verificeret kun når den nuværende produktionsbrugerflade, prosa og skærmbillededækning har Alle er blevet gennemgået.
  6. Kør make manual_check.
  7. Gennemse produktionsbuildet lokalt med make manual_serve, herunder sprogvælger og alle lokaliserede ruter.

Validering kræver, at hvert publiceret oversættelsestræ indeholder den samme side stier som det engelske kildetræ. Den afviser også oversatte sidekroppe, der er identiske med engelsk, så nye sider kan ikke stille sendes som uoversatte kopier. De offentlige engelske URL'er forbliver uændrede; Andre sprog er udgivet under deres egen versionerede lokalitetspræfiks.

Hold dækningslisten autoritativ

Inventaret definerer V1's engelsk-manual-grænse: hver Beamer-side, hver Indstillinger V2 blad eller editor, og alle større arbejdsgange, der skaber eller er materialistiske ændrer data eller tværskærende konfiguration. Hver post registrerer sin ejerskab kildefil og et kildetekstanker. Validering fejler, hvis en af dem forsvinder, hvilket tvinger en rute- eller UI-ændring til at opdatere den manuelle revision i stedet for at forlade en usynlig, stillestående konflikt.

Dækningsstater har bevidst strenge betydninger:

  • Planlagt betyder, at fladen er kendt, men stadig mangler fuld dækning.
  • Dokumenteret betyder, at der findes nyttig prosa, men at skærmbilleder fra den aktuelle produktion eller en fuld nøjagtighedsgennemgang stadig mangler.
  • Verificeret betyder, at den relevante funktionsside er verificeret og understøttet af registrerede produktionsskærmbilleder.

Kør npm --prefix docs-site run coverage:complete som udgivelsesport. Den fejler, indtil alle inventariserede flader er verificeret; almindelige inkrementelle Manual-builds fortsætter med at rapportere de resterende optællinger uden at blokere emneforpligtelser.

Tilføj et screenshot-case

  1. Tilføj eller genbrug en deterministisk Flutter screenshot-sele.
  2. Registrer sagen og dens fire kildebilleder i docs-site/metadata/screenshot-cases.json.
  3. Læg synlig fixturetekst bag manualScreenshotText(...) for hvert understøttet sprog, når den ikke allerede leveres af appens lokaliseringsfiler.
  4. Optag hvert sprog i ../lotti-docs, aldrig i dette arkiv.
  5. Generer og valider mediemanifestet.
  6. Henvis til sagen med <ManualScreenshot caseId="…" alt="…" /> på hver sprogsideside.

Alle appskærmbilleder på en forfattet side skal bruge ManualScreenshot. Direkte links til gamle lotti-docs-billeder fejler manuel validering, fordi de ikke kan følge det globale Mobile/Desktop-valg eller manualens lyse/mørke tema.

Hver automatiseret sag skal levere mobile-light-, mobile-dark-, desktop-light- og desktop-dark-varianter på hvert udgivet sprog. Manual-komponenten vælger det matchende sprog og tema. Når Mobile/Desktop ændres på et billede, opdateres alle skærmbilleder straks, og valget bevares på tværs af sider og åbne manualfaner.

Publish a release

Manualkilden kopieres ikke for hver appversion. Appens udgivelsestag bevarer allerede den præcise kilde. CI tjekker dette tag ud, bygger med MANUAL_VERSION=<version> og udgiver en uforanderlig statisk mappe. Udgivelsesdropdownen er et lille manifest over disse mapper.