Loyihalar yaratish | Cirth Hujjatlar

Loyihalar Cirth-dagi hujjatlaringizning asosidir. Har bir loyiha o'z sahifalari, versiyalari va sozlamalariga ega alohida hujjatlashtirish saytini ifodalaydi.

Loyiha sozlamalari

Loyiha yaratishda yoki tahrirlashda siz quyidagilarni sozlashingiz mumkin:

Asosiy ma'lumotlar

Maydon	Tavsif	Misol
Nomi	Navigatsiyada ko'rsatiladigan nom	"Acme SDK hujjatlari"
Slug	URL identifikatori (nomdan avtomatik yaratiladi)	"acme-sdk"
Tavsif	SEO va ro'yxatlar uchun qisqacha tavsif	"Acme SDK uchun rasmiy hujjatlar"

Brending

Hujjatlaringiz ko'rinishini moslashtiring:

Logo: Logotip rasmini yuklang (tavsiya etiladi: 200x200px PNG)
Favicon: Brauzer tabidagi belgi (16x16 yoki 32x32 ICO/PNG)
Mavzu: Oldindan tayyorlangan rang sxemasini tanlang

Ko'rinish sozlamalari

Hujjatlaringizga kimlar kirishi mumkinligini nazorat qiling:

Ommaviy kirish (Public Access)

Yoqilganda:

Har kim hujjatlaringizni ko'rishi mumkin
Tizimga kirish talab qilinmaydi
Ommaviy profilingizda ko'rinadi

O'chirilganda:

Hujjatlarga faqat siz kira olasiz
Qoralama yoki ichki hujjatlar uchun foydali

Qidiruv tizimini indekslash (Search Engine Indexing)

Yoqilganda:

Qidiruv tizimlari sahifalarni skanerlashi va indekslashi mumkin
Avtomatik ravishda XML sayt xaritasi (sitemap) yaratiladi
SEO uchun tegishli meta teglar qo'shiladi

O'chirilganda:

robots.txt skanerlarni bloklaydi
Hujjatlarni qidiruv natijalaridan yashirin saqlaydi

Bir nechta loyihalarni boshqarish

Boshqaruv panelidan siz quyidagilarni amalga oshirishingiz mumkin:

Barcha loyihalarni ko'rish - Tezkor statistika bilan har bir loyiha kartalarini ko'ring
Loyihalarni qidirish - Loyihalar ko'p bo'lganda nomi bo'yicha saralang
Loyihalarni tartiblash - Nomi, yaratilgan sanasi yoki oxirgi yangilanganligi bo'yicha tartiblang
Loyihalarni arxivlash - Eskirgan loyihalarni o'chirmasdan yashiring

Loyiha tahlili (Analytics)

Har bir loyiha quyidagilarni kuzatib boradi:

Jami ko'rishlar: Barcha sahifalar bo'ylab umumiy ko'rishlar soni
Mashhur sahifalar: Eng ko'p tashrif buyurilgan hujjatlar sahifalari
Versiyadan foydalanish: O'quvchilar qaysi versiyalarga ko'proq kirishadi

Eng yaxshi amaliyotlar

Nomlash qoidalari

Aniq va tavsiflovchi nomlarni tanlang:

Yaxshi: "To'lov API v2 hujjatlari"
Yomon: "Hujjatlar" yoki "Yangi loyiha"

Slug tanlash

Sluglar URL manzillarida ko'rinadi, shuning uchun ularni:

Qisqa va esda qoladigan qiling
Kichik harflar va chiziqchalar bilan yozing
Mahsulotingiz nomiga bog'liq qiling

      
        plaintext
        
      
    https://cirth.app/docs/payment-api    ✓ Yaxshi
https://cirth.app/docs/my-new-docs-1  ✗ Yomon

Har bir mahsulot uchun bitta loyiha

Quyidagilar uchun alohida loyihalar yarating:

Turli xil mahsulotlar yoki xizmatlar
Asosiy API versiyalari (v1 va v2)
Turli auditoriyalar (foydalanuvchilar va dasturchilar)

Loyihalarni o'chirish

Loyihani o'chirish uchun:

Loyiha sozlamalari (Project Settings) ga o'ting
Xavfli zona (Danger Zone) qismiga tushing
Loyihani o'chirish (Delete Project) tugmasini bosing
Loyiha nomini yozish orqali tasdiqlang

Ogohlantirish: O'chirish doimiydir va barcha sahifalar, versiyalar va tarixni o'chirib tashlaydi.