1. lépés — Csatlakoztasd widgethez
Mielőtt bármi nyilvánosan elérhetővé válna, a dokumentációt egy widgethez kell csatlakoztatni. A widget biztosítja a nyilvános URL-t és a vizuális arculatot.
- Menj ide: Dashboard → Widgetek → [a te widgeted] → Beállítások.
- Keresd meg a Dokumentáció részt, és válaszd ki a dokumentációdat.
- Mentsd el.
A dokumentációd a https://{widget-subdomain}.yaplet.help/d/ URL-en lesz elérhető, ha a kategóriák és oldalak közzé vannak téve.
2. lépés — Tegyél közzé egy kategóriát
A nem közzétett kategóriák láthatatlanok a látogatók és az AI számára. Egy kategória közzétételéhez:
- Kattints a dokumentációdba, és nyisd meg a kategóriát.
- A kategória fejlécében keressd meg a Közzétett kapcsolót, és engedélyezd.
- Vagy nyisd meg a Kategória beállításait, és kapcsold ott be a közzétételt.
Egy kategória közzétételének visszavonása azonnal elrejti az összes benne lévő oldalt — még azokat is, amelyeket egyenként tettél közzé. A kategória újbóli közzététele nem teszi automatikusan közzé az oldalait.
3. lépés — Tegyél közzé oldalakat
Minden oldalnak saját Közzétett kapcsolója van a jobb oldali szerkesztőpanelen. Egy oldalt csak akkor lehet közzétenni, ha a kategóriája már közzé van téve.
- Jelöld ki az oldalt a bal oldali fában.
- Kapcsold be a Közzétett kapcsolót a szerkesztőpanel fejlécén.
- Mentsd el.
A közzétett oldalak megjelennek a nyilvános oldal navigációjában, és automatikusan indexelve lesznek az AI-tudásbázishoz. Ugyanez az index működteti a dokumentációs oldal keresőjében a Kérdezd az AI-t asszisztenst is — a látogatók egy AI-jal cseveghetnek, amely a közzétett oldalaid alapján válaszol, és linkeli is a forrásoldalakat.
Oldal linkjének megosztása
Ha egy oldal közzé van téve, kattints a Megosztás gombra a szerkesztőben egy link eléréséhez. Kétféle linktípus érhető el:
- Közvetlen link — emberek által olvasható URL, a kategória- és oldalneveket használva. Példa:
/d/elso-lepesek/telepites. Jó a SEO-hoz. Elromlik, ha az oldalt vagy a kategóriát átnevezed. - Állandó link — az oldalazonosítót használó, örök érvényű URL. Példa:
/d/redirect?id=abc123. Soha nem romlik el. Ezt érdemes használni a termékedbe ágyazott, dokumentációs oldalon vagy az ügyfeleknek küldött linkekhez.
Tömeges közzététel
Ha sok oldalt kell egyszerre közzétenni, használd a tömeges lehetőségeket ahelyett, hogy oldalanként kapcsolgatnád:
- A kategória fejlécéből: hárompontos menü → Összes oldal közzététele (előbb a kategóriának közzé kell lennie). Ez közzéteszi a kategóriában lévő összes nem közzétett oldalt.
- Egy szülő-oldalról: a fában lévő oldal hárompontos menüje → Összes gyermek közzététele. Választhatsz, hogy csak a közvetlen gyermekeket, vagy az összes beágyazott leszármaozottat teszed-e közzé.
A tömeges műveletek kihagyják a már a célállapotban lévő oldalakat. Csak az újonnan közzétett oldalak kerülnek be az AI-tudásbázisba, így a művelet hatékony marad.