Dokumentace — Soul of Herbs

Veškerá podkladicová dokumentace (produkt, technika, obsah) pro databázi bylin je v této složce docs/ uvnitř repozitáře. Kořen repozitáře je zároveň kořenem aplikace (React Router + Workers); vstupní přehled je v README.md.

Soubory v této složce používají číslovaný prefix (např. 20-…) kvůli pořadí a vyhledávání v editoru.


Stav dokumentů (konvence)

V jednotlivých souborech je pod hlavním nadpisem blok „Stav dokumentu“ (blockquote): shrnuje, zda jde o hotový text specifikace, živý checklist vůči kódu, nebo rozpracovaný plán.

  • - [x] — hotovo / zapracováno / text specifikace považovaný za platný.
  • - [ ] — zbývá dodat, ověřit v aplikaci, nebo rozšířit.

Checkboxy uvnitř dokumentu sledují stejný význam; u čistě popisných dokumentů mohou být všechny položky odškrtnuté jako „definováno v tomto dokumentu“.

Složka done/ — uzavřené dokumenty

Soubory ve docs/done/ jsou přesunuté dokončené specifikace (stav Hotovo). Ve webové dokumentaci na /dokumentace/:slug zůstávají dostupné pod stejným slugem jako dříve (např. 12-mvp-1, 11-roadmap, 22-data-model).


Tech stack a nasazení

Jeden centrální soubor — 20-tech-stack.md — stack, doména soulofherbs.com, autodeploy z GitHubu, tabulka „co je v repu vs. plán“ (D1, R2, KV, …).


Jak se orientovat

Dvě nezávislé osy plánování:

  1. Produkt (co dodávat uživatelům) — MVP1–MVP5 (done/12-mvp-1.md16-mvp-5.md) a rozcestník 11-roadmap.md nebo stručný 10-product-spec.md.
  2. Engineering (jak postavit aplikaci) — fáze 1–8 v 24-engineering-roadmap.md.

Začít doporučujeme od 11-roadmap.md nebo od 10-product-spec.md.


Přehled souborů

Produkt

SouborObsah
10-product-spec.mdVize, moduly, karta byliny, filtrace, tradice × věda, způsoby zpracování, checklist MVP (stručně).
11-roadmap.mdRozcestník MVP1–MVP5, uživatelé, principy, IA, entity.
12-mvp-1.md16-mvp-5.mdDetailní produktové zadání jednotlivých MVP; u MVP1 navíc §7 — UX katalogu /byliny, detailu a SEO quick wins.

Technika a implementace

SouborObsah
20-tech-stack.mdStack, doména, autodeploy, D1/R2/KV stav vs. plán.
21-tech-spec.mdTech řešení: React Router v7 + Workers.
22-data-model.mdNávrh hlavních DB entit (vč. images.r2_key).
23-api-and-routes.mdVeřejné, admin a API routy.
24-engineering-roadmap.mdTechnické fáze 1–8 (infra → pokročilé vyhledávání).
25-app-skeleton-plan.mdPlán kostry: deployovatelný skelet → šablona MVP1 → data.

Obsah a UI

SouborObsah
30-content-guidelines.mdObsah, vědecké zdroje, spirituální část.
31-byliny.mdEvidence bylin, stav zapracování, vazba na migrace (0004).
26-ui-components.mdPlánované React komponenty (web + admin).
27-soft-nature-ui.mdSoft „nature“ vizuální téma webu: soubory, údržba, a11y, rozšíření.

Historické názvy

  • 05-mvp-roadmap.md24-engineering-roadmap.md (mezikrok byl 05-engineering-roadmap.md); přejmenování proběhlo, aby se technická roadmapa nemíchala s produktovými MVP1–MVP5.
  • Reorg 2026-05 přečísloval všechny soubory do skupin 10–19 produkt, 20–29 technika a implementace, 30–39 obsah. Soubory bez prefixu (roadmap.md, tech-stack.md, mvp-N.md, byliny.md, ui-components.md) dostaly nový prefix; obsah souborů se nezměnil.