Repositori ini menyimpan kode sumber untuk dokumentasi pembuat di create.roblox.com/docs.
Catatan : Saat ini, repositori memiliki panduan, tutorial, konten pendidikan, dan referensi Engine API. Contoh kode akan segera hadir.
Jika Anda tidak terbiasa dengan proses kontribusi GitHub, lihat Tentang permintaan penarikan dan video berikut.
Jika Anda menemukan masalah dengan dokumentasi dan tidak ingin mengirimkan permintaan penarikan, harap beri tahu kami dengan melaporkannya di forum pengembang Roblox.
Penambahan apa pun pada dokumentasi pembuat Roblox harus sesuai dengan keseluruhan yang lebih besar. Dengan kata lain, bahkan postingan blog atau whitepaper teknis yang komprehensif, akurat, dan ditulis dengan baik mungkin tidak mendapat tempat di situs web.
Secara umum, kami mencari konten yang sesuai dengan standar kami yang ada dan berlaku untuk berbagai pengalaman dan kasus penggunaan. Misalnya, kami lebih memilih halaman seperti Membangun Antarmuka Pengguna daripada halaman seperti Membuat Speedometer untuk Game Balapan . Pertimbangkan untuk memposting panduan yang lebih khusus ke forum pengembang Roblox.
Saat Anda mengirimkan permintaan penarikan untuk peninjauan, Anda harus menyetujui hal berikut:
Kontribusi ini dibuat seluruhnya atau sebagian oleh saya, dan saya berhak mengirimkannya berdasarkan ketentuan lisensi sumber terbuka repositori ini.
Saya memahami dan menyetujui bahwa kontribusi dan catatannya bersifat publik, dipelihara tanpa batas waktu, dan dapat didistribusikan kembali berdasarkan ketentuan lisensi sumber terbuka repositori ini.
Sejauh pengetahuan saya, semua perubahan yang diusulkan adalah akurat.
Untuk perubahan sederhana yang hanya menyentuh satu file, gunakan editor berbasis web GitHub:
Temukan file di content/en-us/
dan klik Edit file ini .
Klik Fork repositori ini .
Buat perubahan Anda dan klik Komit perubahan... .
Berikan perubahan Anda pesan penerapan deskriptif dan klik Usulkan perubahan .
Pastikan repositori dasarnya adalah Roblox/creator-docs
dan cabang dasarnya adalah main
. Verifikasi bahwa Anda puas dengan perubahan Anda dan klik Buat permintaan penarikan .
Terakhir, isi detail di deskripsi permintaan tarik dan klik Buat permintaan tarik .
Untuk perubahan lebih besar yang mencakup banyak file, kami merekomendasikan github.dev, editor teks berfitur lengkap berdasarkan Visual Studio Code yang berjalan di browser Anda:
Cabangkan repositori.
Saat menjelajahi fork Anda, tekan tombol . kunci untuk membuka github.dev.
Di menu Kontrol Sumber , klik ... > Cabang > Buat Cabang... .
Beri nama cabang tersebut dan klik Switch to Branch .
Gunakan menu Explorer untuk menemukan file yang ingin Anda perbarui di content/en-us
, dan buat perubahan yang Anda inginkan.
Di menu Kontrol Sumber , verifikasi bahwa Anda puas dengan perubahan Anda.
Tambahkan pesan komit dan klik Komit & Dorong .
Di tab browser baru, navigasikan ke github.com/Roblox/creator-docs.
Klik Bandingkan & tarik permintaan .
Verifikasi bahwa repositori dasar adalah Roblox/creator-docs
dan cabang dasarnya adalah main
. Repositori kepala harus menjadi garpu dan cabang Anda.
Terakhir, isi detail di deskripsi permintaan tarik dan klik Buat permintaan tarik .
Alternatifnya, Anda dapat menggunakan menu GitHub atau GitHub Pull Request di github.dev untuk mengirimkan permintaan pull. Untuk dokumentasi tentang penggunaan github.dev, lihat GitHub Codespaces.
Repositori ini sangat besar, jadi kami menyarankan untuk menggunakan opsi online bila memungkinkan. Namun, jika Anda sudah terbiasa dengan alur kerja GitHub secara umum dan ingin menggunakan editor teks offline, berikut adalah langkah-langkah dasar untuk berkontribusi pada dokumentasi:
Siapkan Git dan Git LFS. Alternatifnya, instal klien Git seperti GitHub Desktop.
Garpu repositori ini.
Kloning garpu Anda.
Arahkan ke root repositori.
Buat cabang baru.
Buat perubahan yang Anda inginkan.
Komit, dorong ke fork Anda, dan kirimkan permintaan penarikan Anda ke cabang main
repositori ini.
Untuk langkah lebih detail, lihat CONTRIBUTING.md.
Dokumentasi Roblox memiliki tiga jenis dokumen utama:
Panduan konseptual dan berbasis tugas dalam file .md
di content/en-us/
Panduan mengajarkan Anda tentang fitur atau alur kerja tanpa terlalu menentukan hasil akhirnya. Mereka memperkenalkan konsep dan fitur serta mencakup tugas yang dapat Anda selesaikan dengan menggunakan berbagai alat atau pendekatan lain.
Panduan mendapat manfaat besar dari kasus penggunaan praktis di dunia nyata, gambar, cuplikan kode, dan diagram. Sebagian besar konten berbasis tugas harus menyertakan daftar bernomor.
Dokumen referensi API dalam file .yaml
di content/en-us/reference
API sepenuhnya merupakan konten referensi dan harus menggunakan deskripsi fungsional, yang ditautkan ke panduan jika diperlukan. Dibandingkan tipe konten lainnya, konten referensi harus singkat dan langsung; ringkasan untuk properti, metode, peristiwa, dan panggilan balik tidak harus berupa kalimat lengkap.
Tutorial dalam file .md
di content/en-us/tutorials
Dibandingkan dengan panduan berbasis tugas, tutorial lebih mandiri dan membawa Anda dari nol menjadi sesuatu . Fokus pada penciptaan sesuatu yang spesifik berarti bahwa hal tersebut biasanya lebih bersifat preskriptif dibandingkan panduan. Tutorial sering kali menyentuh beberapa fitur dan konsep secara bersamaan, menunjukkan hubungan antara alat dan strategi.
Jika kontribusi Anda tidak sesuai dengan kategori ini atau mencakup subjek yang sempit, mungkin kontribusi tersebut tidak cocok untuk dokumentasi. Pertimbangkan untuk mempostingnya ke forum pengembang Roblox.
Cobalah untuk membatasi pengeditan Anda pada satu kelas atau fitur sehingga permintaan penarikan lebih mudah untuk ditinjau. Perbaikan bug dan peningkatan kecil memiliki kemungkinan lebih tinggi untuk mendapatkan persetujuan cepat. Panduan berukuran besar sering kali memerlukan bolak-balik yang signifikan sebelum dipublikasikan.
Untuk menghindari masalah pemformatan, kami merekomendasikan editor teks seperti github.dev yang memungkinkan Anda melihat pratinjau Markdown saat Anda menulisnya. Untuk prosa, coba ikuti panduan di STYLE.md. Untuk contoh kode, gunakan Lua Style Guide.
Untuk melihat halaman yang diformat sepenuhnya sesuai dengan apa yang kita lihat di cabang main
, ganti seluruh URL dari content/
dan sebelumnya. File dengan index
nama dasar harus dihapus namanya. Misalnya, halaman untuk "https://github.com/Roblox/creator-docs/blob/main/content/en-us/avatar/index.md" dirender di "https://create.roblox.com /docs/en-us/avatar".
Untuk prosa, proyek ini menggunakan Creative Commons Attribution 4.0 International Public License. Untuk teks lisensi lengkap, lihat LISENSI.
Contoh kode tersedia di bawah Lisensi MIT. Untuk teks lisensi lengkap, lihat KODE LISENSI.
Untuk menjaga komunitas yang terbuka, ramah, beragam, inklusif, dan sehat, proyek ini menerapkan versi Perjanjian Kontributor yang diadaptasi. Untuk informasi lebih lanjut, lihat CODE_OF_CONDUCT.md.