Weblate belgelerine katkıda bulunun

İstediğiniz belgeler sayfasını iyileştirebilirsiniz. Bunun için sayfanın sağ üst köşesindeki GitHub üzerinde düzenle düğmesine tıklayarak kolayca yapabilirsiniz.

Belgeleme kuralları

Lütfen yazarken şu kurallara uyun:

  1. Geçerliyse, belgenin bir bölümünü kaldırmayın.

  2. Açık ve kolay anlaşılır bir dil kullanın. Teknoloji belgeleri yazıyorsunuz, şiir değil. Belgeleri okuyacak herkesin ana dili İngilizce değildir, düşünceli olun.

  3. Emin değilseniz sormaktan çekinmeyin. Düzenleme yaparken bazı özellikler ile ilgili soru sormanız gerekiyorsa, yanıtı almadan önce belgeleri değiştirmeyin. Özetle: Değiştirin ya da sorun. İkisini aynı anda yapmayın.

  4. Belgeleri izlerken açıklanan işlemleri yaparak değişikliklerinizi doğrulayın.

  5. Onaylama ve birleştirmenin daha kolay ve hızlı yapılması için çekme isteğinde küçük değişiklik parçaları gönderin.

  6. Büyük bir makaleyi yeniden yazmak ve yapısını değiştirmek istiyorsanız, bunu iki adımda yapın:

    1. Yeniden yazın

    2. Yeniden yazma onaylandıktan, iyileştirildikten ve birleştirildikten sonra, başka bir çekme isteğinde paragrafların yapısını değiştirin.

Belgeleri yerel olarak oluşturmak

Belgeler yerel olarak da düzenlenebilir ve oluşturulabilir, Python gereksinimleri pyproject.toml içindeki docs bağımlılık grubundadır. Yapım ci/run-docs kullanılarak oluşturulabilir.

İpucu

Belgeleri oluşturmak için graphviz programının kurulmuş olmasına da gerek duyacaksınız.

Belgeleri çevirmek

Belgeleri çevirebilirsiniz.

İzinleri, denetimleri, eklentileri ve kendiliğinden önerileri belgelemek

Çeşitli belgeleme bölümleri koddan oluşturulan kalıpları kullanır. Şu yönetim komutları kullanılabilir:

Tüm bu komutlar, belgeleme için bir kalıp olarak kullanılan reStructuredText çıktısı verir. Belgelerdeki değişiklikleri uygulamanın en kolay yolu düzenleyicinizde visual diff kullanmaktır.