Dokumentáció
A Dokumentáció oldal egy nyilvános dokumentációs oldal a termékedhez — oldalsáv, tartalomjegyzék, beépített AI asszisztenssel kiegészített teljes szöveges keresés és markdown megjelenítés —, a márkád saját webcímén kiszolgálva.
Áttekintés
A dokumentációs oldal egy strukturált, fejlesztőbarát oldalhalmaz, amit a márkád saját webcímén, a /d útvonalon szolgálunk ki. Technikai dokumentációhoz, termékútmutatókhoz, API-referenciákhoz és minden olyan tartalomhoz való, ami jobban olvasható oldalsávval és tartalomjegyzékkel.
Oldalsáv navigáció
Összecsukható fastruktúra az oldalak és a beágyazott szekciók közötti mozgáshoz.
Teljes szöveges keresés
Keresés az oldalcímekben, leírásokban és tartalomban — vagy kérdezd a beépített AI asszisztenst.
Tartalomjegyzék
Az oldal saját címsoraiból készül, és kiemeli, melyik szakaszt olvasod éppen.
Kategória fülek
Oszd a dokumentációt több kategóriára, mindegyiknek saját oldalfájával.
A webcím
A dokumentációs oldalad ezen a címen érhető el:
https://<a-marka-cimed>.yaplet.help/d
Egy márkának lehet <nev>.yaplet.help alakú webcíme, amit a Márka → Márkabeállítások → Nyilvános cím alatt állítasz be. Semmit nem kell chat widgethez csatlakoztatni — a cím a márkához tartozik, és a dokumentáció akkor is kiszolgálásra kerül, ha sehol nincs chat buborék.
Aki a /d címet nyitja meg, egyből az első kategóriához és annak első oldalához kerül. Ha a dokumentációnak nincs kategóriája, a cím helyette nem-található oldalt ad vissza.
<cím>, egy élő sor menüjében a Levétel a nyilvános oldalról pont található. Egy márka egyszerre egy dokumentációt szolgál ki; a többi megmarad AI-tudásnak, csak nem érhető el a címen.Az oldal elrendezése
A dokumentációs oldal háromoszlopos elrendezést használ:
| Oszlop | Pozíció | Tartalom |
|---|---|---|
| Oldalsáv | Bal (320px) | Oldalfa összecsukható szekciókkal |
| Tartalom | Közép (max 768px) | Az oldal tartalma markdown-ként megjelenítve |
| Tartalomjegyzék | Jobb (256px) | Az oldal H2 és H3 címsoraiból generálva |
Telefonon és tableten az oldalsáv és a tartalomjegyzék csúszó panelekbe kerül, amelyeket a fejléc gombjai nyitnak meg.
Navigáció
- Előző / Következő linkek minden oldal alján, a végigolvasáshoz
- Útvonal alakú címek, amelyek tükrözik az oldalhierarchiát:
/d/guides/getting-started/installation - Csoport oldalak (csoportként jelölt vagy saját tartalom nélküli oldalak) az első gyermekoldalukra irányítanak
Kategóriák
Ha a dokumentációnak egynél több kategóriája van, a fejléc alatt megjelenik egy fülsáv. Minden fül betölti az adott kategória oldalfáját az oldalsávba.
Keresés
A keresősáv a fejléc közepén található. Az eredmények teljes képernyős felületen nyílnak meg, három csoportban:
- Cím találatok — oldalak, amelyek címében szerepel, amit begépeltél
- Leírás találatok — oldalak, amelyek leírásában szerepel
- Tartalom találatok — oldalak, amelyek szövegtörzsében szerepel, kiemelt részlettel
Az Escape billentyűvel zárhatod be a felületet.
Kérdezd az AI-t
Ha a keresés nem hozza fel a megfelelő oldalt — vagy a látogató inkább csak kérdezne —, a felületen lévő Kérdezd az AI-t gomb csevegésre váltja. Az asszisztens kizárólag ennek a dokumentációnak a közzétett oldalaiból válaszol:
- A válaszok folyamatosan érkeznek, markdown formázással
- Az asszisztens linkként hivatkozza a felhasznált oldalakat, így a látogatók egyből a forráshoz ugorhatnak
- A beszélgetés a látogató böngészőjében marad, soha nem tároljuk
Tartalom megjelenítés
A dokumentáció oldalai Markdown-ban íródnak, és az MDC (Markdown Components) motor jeleníti meg őket, így egy oldal tartalmazhat:
- Szabványos markdown-t — címsorokat, listákat, táblázatokat, kódblokkokat, képeket
- Gazdag komponenseket, például kiemeléseket, kártyákat, füleket, lépéseket és kódcsoportokat
- Szintaxiskiemelt kódot fájlnév címkékkel és sorkiemeléssel
Oldal másolása LLM-hez
Minden oldalon van egy Oldal másolása LLM-hez gomb, amely a nyers markdown tartalmat a vágólapra másolja, készen arra, hogy elemzéshez vagy kérdésmegválaszoláshoz beilleszd egy AI eszközbe.
Márkázás és stílus
A fejlécben a márka logója jelenik meg, amit a Márka → Márkabeállítások → Általános → Márkaképek → Márkalogó alatt állítasz be. Ez egy fő kép, plusz egy opcionális második változat, ami vagy a világos, vagy a sötét módot foglalja el — nem egy pár, amit kétszer kell kitölteni. Ha egy márka csak a fő képet tölti fel, mindkét módban rendben van.
- Logó — ugyanaz a logó, ami a nyilvános Tudásbázison és a nyilvános roadmapon is szerepel. Az a dokumentáció, amelyik még saját, régebbi logót hordoz, azt használja tovább, amíg a márka nem kap egyet; ha egyik sincs, a fejlécben a "Dokumentáció" szó jelenik meg.
- Sötét / világos váltó — a látogatók a fejlécben váltanak témát, és a logó követi őket, ha az adott módhoz feltöltöttél alternatívát.
A chat widget ezeken az oldalakon
Egy oldal közzététele az, ami beteszi a márka AI-tudásába, és ez azonnal megtörténik — nem kell hozzá sem chat widget, sem AI ügynök.
Ha a márkának van chat widgetje, az be van ágyazva a dokumentáció oldalaiba, így a látogatók olvasás közben beszélgetést kezdhetnek. Ez a widget a súgó füle tetején linket is mutathat erre a dokumentációra: a kapcsoló neve Dokumentáció Link, a Márka → Chat widget → Funkciók alatt.
Oldalhierarchia
A dokumentáció oldalai olyan mélyen ágyazhatók, amilyen mélyen szükséges, tehát ilyen szerkezetek is rendben vannak:
Útmutatók (kategória)
├── Első lépések
│ ├── Telepítés
│ ├── Konfiguráció
│ └── Kezdő lépések
├── Haladó témák
│ ├── Hitelesítés
│ └── Webhookok
└── API referencia
├── Végpontok
└── Hibakódok
A csoport oldalak szekciófejlécként működnek — az oldalsávban kibontható csomópontként jelennek meg, saját tartalom nélkül, és rájuk kattintva kibomlanak, az olvasó pedig az első gyermekoldalukra kerül.