- templatemodule.json — Agentic modül şeması rol atamları
Klasör Şablonu
Her klasörde bunu kullanın. Kasıtlı olarak minimal, öngörülebilir ve öğrenci dostudur.
README: Birincil Hikaye
Burası klasörün hikayesini yerleştirdiğiniz yerdir — "neden", "nasıl", kavramsal yapıştırıcı.
ABOUT: Anlatı
Bu, kavramsal bir HTML dilimi — basit, temiz ve "Markdown'ı repodan oluştur" felsefesi ile tam uyumlu.
Sayfayı şu şekilde tutar:
- sessiz
- sezgisel
- arama-ilk
- anlatı olmayan
- çoğaltma olmayan
Tam olarak "HipChat Google'la buluşur" vibesı.
Arama: Davranış Kontratı
Bu, arama kutusu için davranış kontratıdır — açık, öngörülebilir ve uygulanması kolay.
Kanonik, öngörülebilir, substrat-hizalı bir arama sistemi verir — hatırladığınız HipChat botları gibi hissettiren — hızlı, edebi ve müdahale olmadan yardımcı.
Index: Navigasyon
(Klasörün README.md'sini sarar — basit, sessiz ve GitHub dostudur)
Statik site rendereriniz Markdown'ı bir içerik kapsayıcıya yüklediğini varsayar. Kullanıcı arayüzünü minimal tutar ve arama-ilk başlangıç sayfanızla tutarlı.
Klasör düzeyinde sayfaları temiz, öngörülebilir ve genel estetiğinizle hizalandı tutar.
Rotator: Görsel
(Hafif, bağımlılık yok, minimal HTML felsefeniz ile çalışır)
Bu komut dosyası, küçük bir görsel seti arasında döner (RTT diyagramları, substrat motifleri, vb.). Bunu başlangıç sayfanıza veya herhangi bir klasör düzeyinde indekse bırakabilirsiniz. Aralığı günlük, saatlik veya sadece yenilemede olacak şekilde ayarlayabilirsiniz.
İnsan: Arama Sonuçları Şablonu
(Temiz, okunabilir ve arama-ilk başlangıç sayfanızla tutarlı)
Bu düzen, istediğiniz arama motorunu takabilmeniz için kasıtlı olarak basittir (yerel dizin, Lunr.js, özel arka uç, vb.).
Size verir:
- temiz gruplandırma
- okunabilir snippet'ler
- açık kaynak etiketlemesi
- yalnızca kanonik bağlantılar
- hiçbir dağınıklık
Araştırma substratı için mükemmel.
Sitemap: Jeneratörü
(Hafif, bağımlılık yok, Markdown-ilk repo ile çalışır)
Bu komut dosyası repo'nuzda yürür, Markdown dosyaları + alt klasörleri bulur ve her klasör için sitemap.json'u veren.
Şuraya kaydet: /scripts/generate-sitemaps.js
- Sıfır bağımlılık
- Herhangi bir CI/CD'de çalışır
- GitHub Actions ile çalışır
- Bakımı kolay
- Markdown-ilk repo için mükemmel
Global Sitemap
Bu, tüm klasör düzeyinde sitemap.json dosyalarını bir araya getiren ana sitemap'tir. İt, search motorunuza, navigasyon araçlarınıza ve dış sistemlere tek bir kanonik omurga verir.
Arama Dizini
Deposu arasında tüm Markdown dosyalarının aranabilir bir dizinini oluşturur. Hafif, hızlı ve arama-ilk başlangıç sayfanız için mükemmel.
- Arka uç yok
- Sunucu yok
- Tamamen istemci tarafında çalışır
- Statik siteler için mükemmel
- Binlerce belge için yeterince hızlı
Arama kutunuz artık bu dizini yükleyebilir ve anlık, çevrimdışı arama gerçekleştirebilir.
Repo Haritası
Tüm repo'nun insan tarafından okunabilir, yapısal bir haritası oluşturur — mükemmel /docs/meta/ veya katkı yapan onboarding için.
CI/CD Entegrasyonu
Yapı hattınız otomatik olarak yeniden oluşturur:
- starthere.json
- sitemap.json
- sitemapindex.json
- searchindex.json
Belgelendirmeniz kendi kendini korur hale gelir.
Bu komponent, triadı tamamlar:
| Katman | Amaç | Kaynak |
|---|---|---|
| Başlangıç Sayfası | Arama-ilk, dinamik Başla | searchindex.json, starthere.json |
| README.md | Navigasyon-ilk | Statik Markdown |
| ABOUT.md | Anlatı | Statik Markdown |
Başla UI, dinamik katmandır, içeriğe dokunmadan sitenizi taze tutar.
