Údržba této příručky

Zdroj žije v repozitáři aplikace, aby změna chování a její dokumentace mohly přijít společně. Vygenerované snímky žijí v sousedním repozitáři lotti-docs a nikdy se necommitují do stromu aplikace.

Upravuj text

1. Uprav nebo přidej anglický MDX soubor v docs-site/docs.
2. Aktualizuj odpovídající soubor každého publikovaného jazyka v docs-site/i18n/<jazyk>/docusaurus-plugin-content-docs/current.
3. Novou stránku přidej do docs-site/sidebars.ts.
4. Při změně pokrytí aktualizuj docs-site/metadata/features.json.
5. Aktualizuj odpovídající položky v docs-site/metadata/surface-inventory.json. Plocha se stane ověřenou teprve po kontrole aktuálního produkčního UI, textu a snímků.
6. Spusť make manual_check.
7. Produkční sestavení zkontroluj místně pomocí make manual_serve, včetně výběru jazyka a cest jednotlivých lokalizací.

Validace vyžaduje, aby každý publikovaný překlad obsahoval stejné cesty stránek jako anglický zdroj. Odmítá také překlady se stejným tělem jako angličtina, takže nová stránka nemůže tiše vyjít jako nepřeložená kopie. Veřejné anglické URL zůstávají beze změny; ostatní jazyky se publikují pod vlastní předponou v rámci verze.

Udržuj inventář pokrytí autoritativní

Inventář vymezuje hranici anglické příručky V1: každou stránku Beamer, každý list nebo editor Nastavení V2 a každý hlavní postup, který vytváří či podstatně mění data nebo průřezové nastavení. Každá položka uvádí zdrojový soubor a textovou kotvu. Validace selže, pokud některá zmizí, takže změna trasy nebo UI musí aktualizovat audit místo ponechání neviditelného zastaralého řádku.

Stavy pokrytí mají přísný význam:

• Plánováno znamená známou plochu bez úplného pokrytí.
• Zdokumentováno znamená užitečný text, ale chybějící aktuální produkční snímky nebo úplnou kontrolu přesnosti.
• Ověřeno znamená ověřenou stránku funkce podpořenou registrovanými produkčními snímky.

Pro bránu vydání spusť npm --prefix docs-site run coverage:complete. Selže, dokud není ověřena každá plocha; běžná přírůstková sestavení dál hlásí zbývající počty bez blokování tematických commitů.

Přidej případ snímku obrazovky

1. Přidej nebo znovu použij deterministický Flutter harness snímků.
2. Zaregistruj případ a čtyři zdrojové obrázky v docs-site/metadata/screenshot-cases.json.
3. Viditelný ukázkový text, který neposkytují lokalizační soubory aplikace, vlož za manualScreenshotText(...) pro každý podporovaný jazyk.
4. Zachyť všechny jazyky do ../lotti-docs, nikdy do tohoto repozitáře.
5. Vygeneruj a ověř manifest médií.
6. Na každé jazykové stránce odkazuj pomocí <ManualScreenshot caseId="…" alt="…" />.

Každý snímek aplikace na psané stránce musí používat ManualScreenshot. Přímé odkazy na staré obrázky lotti-docs neprojdou validací, protože nemohou následovat globální volbu Mobil/Počítač ani světlý a tmavý motiv příručky.

Každý automatický případ musí poskytnout mobilní světlou, mobilní tmavou, počítačovou světlou a počítačovou tmavou variantu v každém publikovaném jazyce. Komponenta vybere správný jazyk a motiv. Změna Mobil/Počítač na kterémkoli obrázku okamžitě aktualizuje všechny snímky a přetrvá mezi stránkami i otevřenými kartami příručky.

Publikuj vydání

Zdroj příručky se nekopíruje pro každou verzi aplikace. Tag vydání už uchovává přesný zdroj. CI tento tag načte, sestaví s MANUAL_VERSION=<verze> a publikuje neměnný statický adresář. Výběr vydání je malý manifest těchto adresářů.