Wiki

Wiki, deponuzda işbirlikçi belgeleme için bir alan sağlar. Proje belgeleri, kılavuzlar ve bilgi tabanları için mükemmeldir.

Wiki Oluşturma

Wiki'yi Etkinleştirme

  1. Depo Ayarları gidin
  2. "Gelişmiş Ayarlar" altında, "Wiki'yi Etkinleştir" işaretli olduğundan emin olun
  3. Wiki görünürlüğünü seçin:
    • Herkese Açık: Herkes görüntüleyebilir
    • Özel: Sadece işbirlikçiler görüntüleyebilir

İlk Sayfayı Oluşturma

  1. Wiki sekmesine gidin
  2. "İlk sayfayı oluştur" tıklayın
  3. Ekleyin:
    • Sayfa başlığı: Sayfanın adı
    • İçerik: Markdown ile yazın
  4. "Oluştur" tıklayın

Wiki Özellikleri

Markdown Desteği

Markdown sözdizimi ile yazın:

# Başlık 1
## Başlık 2

**Kalın metin**
*İtalik metin*

- Liste öğesi 1
- Liste öğesi 2

[Bağlantı metni](https://example.com)

![Resim alt metni](image-url)

Çoklu Sayfalar

Farklı konular için birden fazla sayfa oluşturun:

  • Home - Ana wiki sayfası
  • Başlarken - Kurulum kılavuzu
  • API Belgeleri - API referansı
  • Dağıtım - Dağıtım talimatları

Sayfa Organizasyonu

  • Kenar çubuğu: Sayfa başlıklarından otomatik oluşturulur
  • Dahili bağlantılar: Wiki sayfaları arasında bağlantı
  • Revizyonlar: Değişiklikleri izleyin ve geçmişi görüntüleyin

Wiki Yönetimi

Sayfaları Düzenleme

  1. Herhangi bir sayfada "Düzenle" düğmesine tıklayın
  2. Değişikliklerinizi yapın
  3. Düzenleme mesajı ekleyin (isteğe bağlı)
  4. "Kaydet" tıklayın

Sayfaları Silme

  1. "Sil" düğmesine tıklayın
  2. Silmeyi onaylayın

⚠️ Uyarı: Silinen sayfalar geri alınamaz!

Sayfa Geçmişi

Tüm revizyonları görüntüleyin:

  1. "Sayfa Geçmişi" tıklayın
  2. Tüm değişikliklerin listesini görün
  3. Sürümleri karşılaştırın
  4. Gerektiğinde önceki sürüme geri dönün

En İyi Uygulamalar

  • ✅ Kapsamlı bir Home sayfası ile başlayın
  • ✅ Açık, açıklayıcı sayfa başlıkları kullanın
  • ✅ İçeriği mantıklı düzenleyin
  • ✅ İlgili olduğunda kod örnekleri dahil edin
  • ✅ Belgeleri güncel tutun
  • ✅ İlgili sayfaları bağlamak için dahili bağlantılar kullanın
  • ✅ Netlik için resimler ve diyagramlar ekleyin

Yaygın Kullanım Durumları

Proje Belgeleri

  • Mimariye genel bakış
  • Kurulum talimatları
  • Yapılandırma kılavuzu
  • API referansı

Takım Bilgi Tabanı

  • Kodlama standartları
  • Dağıtım prosedürleri
  • Sorun giderme kılavuzları
  • İşe alım materyalleri

Kullanıcı Kılavuzları

  • Özellik belgeleri
  • Öğreticiler
  • SSS
  • Örnekler

Wiki ile README Karşılaştırması

Özellik README Wiki
Konum Depo kökü Ayrı wiki bölümü
Amaç Proje genel bakış Ayrıntılı belgeler
Yapı Tek dosya Çoklu sayfalar
İşbirliği Çekme istekleri üzerinden Doğrudan düzenleme
En uygun Hızlı genel bakış Kapsamlı belgeler

Sonraki Adımlar