Strapi katkı vereni dokümantasyonu
Strapi Katkı Veren Dokümantasyonu'na hoş geldiniz.
Hiçbir Strapi ekibi “katkı veren dokümantasyonu” “sahiplenmez”, bu kollektif bir çabadır.
Bu dokümantasyon sitesi sürekli bir geliştirme halindedir, bu yüzden lütfen bu dokümanları eklemeye ve geliştirmeye devam edin. Bunlar “kullanıcıya yönelik” dokümanlar değildir; doğrudan hem iç hem de dış mühendisler için, bununla birlikte teknik kavramları açıklarken, aynı zamanda kancalar, yardımcı araçlar vb. için dokümantasyon içerir.
Eğer strapi/strapi projesine herhangi bir katkıda bulunmayı planlamıyorsanız, mevcut dokümantasyonu okumamalı ve kullanmamalısınız; docs.strapi.io sizin kullanım durumunuz için daha uygun olabilir.
— Strapi Takımı
Yapı
Genel düzen 4 ana alana odaklanmaktadır:
Kılavuzlar
Buradan başlamak isteyebilirsiniz. Katkıda bulunma kılavuzlarımız ve davranış kurallarımız var; bunları okumak çok önemlidir. Ayrıca geliştirme sırasında karşılaşabileceğiniz görüntü gibi “Tasarım Sistemi ile Çalışma” ve ön uç geliştirme için en iyi uygulamalar gibi daha üst düzey kılavuzlar da bulunmaktadır (yakında gelecek).
Belgeler
Belgeler bölümünde, Strapi monorepo'sunun belirli kısımlarına derinlemesine inen teknik ve kavramsal dokümantasyonun bir kombinasyonunu bulabilirsiniz; bunlar kodu okumak kadar anlamlı olmayabilir, örneğin “Veritabanındaki İlişkilerin Yeniden Düzenlenmesi”. Ayrıca, useDragAndDrop kancası gibi çeşitli kod parçalarının kullanım dokümantasyonu bulunmaktadır.
API Referansı
Strapi'nin bazı temel sürücü sınıflarına derinlemesine bir inceleme; yaygın olarak maruz kalan sınıflardaki yöntemler ve parametreler hakkında açıklamalar ve daha kolay anlaşılmasını sağlamak için örnekler içerir.
RFC'ler
Zamanla kamusal RFC'lerle doldurmayı planladığımız büyüyen bir bölüm; bir kez onaylandığında kayıt olarak tutulacaktır. Bu, özelliklerin ve kodların tasarım yönünü anlamada yardımcı olur ve görünmeyen bağlamsal “nedenleri” anlamayı sağlar.
İçerik ne zaman eklenmelidir?
İçerik, genellikle yeni bir özellik eklediğinizde - özellikle işletme düzeyinde, örneğin İş Akışlarını Gözden Geçirme - ve diğer mühendislerin farklı bir kullanım bulabileceği yeni kod eklediğinizde, örneğin yeni bir kanca. Ne ekleyeceğiniz veya ne eklemeyeceğiniz konusunda kesin bir kılavuz yoktur; yukarıda tanımlandığı gibi katkıda bulunanları yönlendirecek çeşitli materyaller ekliyoruz.