Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Ekosistem ARK
- Penulis teknis:
- yslcrypto
- Nama project:
- Project 1 - Panduan Pengembangan Core Blockchain
- Durasi project:
- Durasi standar (3 bulan)
Project description
Berikut beberapa pemikiran setelah membaca bagian Memulai:
CARA MENYIAPAKAN LINGKUNGAN DEV
Penginstalan: Saya akan membahas lebih lanjut cara menginstal alat pengembangan di sini. Saya akan memberikan contoh kode, beserta error umum dan cara memperbaikinya (kita dapat menautkan ke halaman pemecahan masalah di sini).
Memulai testnet pertama Anda: Kesan pertama: saat ini cukup membingungkan bagi seseorang yang hanya melihat sekilas dan ingin menyiapkannya dengan cepat. Berikut beberapa hal yang akan saya ubah:
Saya akan mempertimbangkan untuk mendefinisikan bahkan konsep dasar seperti {i>testnet<i}.
Saya akan memberikan lebih banyak contoh kode yang lebih pendek: mkdir, cd, dll. Saya juga akan mengelompokkan semuanya sehingga pembaca dapat menyalin dan menempel dengan lebih mudah. Tidak ada yang terlalu sederhana, dan semua orang suka menyalin dan menempel.
Pada pembacaan pertama, saya tidak mengerti apa yang dicapai oleh langkah 1 dan 2 dari subbagian booting jaringan. Mengklik dan membuka link memerlukan terlalu banyak pemikiran. Saya rasa kita dapat membuatnya lebih jelas tanpa terlalu mendalami detailnya.
Setidaknya saya akan memberikan ringkasan umum tentang core-container di langkah 5 (yang menurut saya sebenarnya adalah langkah 4?) sehingga pembaca memiliki beberapa intuisi tentang apa yang mereka lakukan tanpa mengikuti link.
Untuk langkah 3 dan 5 (benar-benar 4), saya akan menjelaskan contoh kode yang lebih panjang.
Untuk langkah terakhir, saya akan menautkan ke plugin dan file yang diinstal untuk memudahkan pembaca.
Terakhir, saya akan mengedit dengan cara yang memastikan tidak ada lebih dari satu ide per paragraf (memungkinkan pembacaan sekilas yang mudah). Saya juga akan membuat nadanya sedikit lebih menyenangkan / ramah, dan menambahkan beberapa emoji.
CARA MENGAWASI BLOCKCHAIN
Saya akan menyederhanakan paragraf pertama. Saya akan menjelaskan apa itu plugin, apa yang dilakukan delegasi (atau setidaknya memberikan link ke penjelasan prinsip pertama), apa yang dimaksud dengan membuat blok, dan memberikan contoh peristiwa jaringan.
Menentukan masalah: Saya akan memberi pembaca intuisi tentang apa itu node penuh, memberikan link ke penjelasan yang lebih mendetail, dan menjelaskan dengan lebih baik kompromi antara node penuh dan aplikasi eksternal. Terakhir, saya akan memberikan link ke halaman memulai sebelumnya -- cara menyiapkan testnet dan lingkungan pengembangan yang berfungsi -- di akhir subbagian ini (jika pembaca menemukan halaman ini terlebih dahulu).
Events API: Tidak jelas -- dari daftar peristiwa yang tersedia -- bahwa kita harus menggunakan 'block.applied' untuk mendapatkan yang kita inginkan. Meskipun Tips di bawah ini memperjelasnya, saya akan menjelaskannya terlebih dahulu.
Tidak jelas bagi saya apa yang dihasilkan 'block.applied'. Saya rasa penting untuk menjelaskannya dengan jelas.
Dalam contoh kode di bagian akhir, sebaiknya jelaskan bahwa 'block.generatorPublicKey' menggantikan 'block.forger' (dalam contoh pseudocode sebelumnya), dan 'delegateKey' menggantikan 'delegateWeAreMonitoring'. Terakhir, untuk memastikan contoh kode dan pseudocode konsisten, saya juga akan menukar 'delegateKey' dan 'generatorKey' dalam pernyataan if.
Membuat plugin: Saya akan menjelaskan arti scaffolding dalam konteks ini. Seperti: Sama seperti perancah yang sebenarnya di lokasi konstruksi, saat kita membahas perancah dalam konteks ini, yang kami maksud adalah struktur bawaan sederhana untuk plugin Anda, yang di atasnya Anda dapat membuat perancah yang sebenarnya.
Saya akan menambahkan contoh kode untuk mengganti nama direktori dan plugin, menunjukkan contoh package.json, dan menjelaskan apa yang kami maksud dengan 'menambahkan konfigurasi yang diperlukan' ke plugin.js.
Merangkumnya: Saya akan memperjelas perubahannya. Dan selesaikan dengan ucapan selamat serta tambahkan emoji lainnya :)
CARA MENGIRIM TRANSAKSI PERTAMA ANDA MENGGUNAKAN ARK SDK
Memulai: Saya akan menambahkan contoh kode untuk memungkinkan pengguna membuat direktori baru dengan menyalin dan menempel.
Menghubungkan ke Testnet: Saya akan menjelaskan apa itu REST API, jika pembaca tidak mengetahuinya (atau setidaknya memberikan link ke penjelasan). Saya akan memberikan dan menautkan ke contoh JSON Viewer. Saya akan menggunakan nada yang lebih ramah di TIP kedua (karena kita meminta bantuan pembaca).
Mengubah Pengelola Konfigurasi: Saya akan menyebutkan contoh umum bug terkait jaringan, dan mempertimbangkan untuk menautkan ke bagian pemecahan masalah.
Menyiapkan Akun Pengirim dan Penerima: Saya akan menambahkan contoh kode untuk memungkinkan pembaca beralih ke direktori konfigurasi dengan menyalin dan menempel. Saya akan menambahkan contoh kode yang menampilkan konten delegates.json.
CARA MENGKIRIM TRANSAKSI MENGGUNAKAN CLI PENGUJI INTI INTI ARK
Prasyarat: Saya akan menambahkan contoh kode yang menunjukkan cara mendapatkan salinan repo GitHub ARK Core yang berfungsi, dan contoh lain yang memindahkan pembaca ke direktori yang tepat.
Dasar: Saya akan membuat paragraf pertama lebih jelas bagi mereka yang tidak memahami variabel lingkungan jalur.
KESIMPULAN
Kesimpulannya, ini hanyalah beberapa catatan singkat yang saya buat saat membaca dokumentasi. Saat kita memulai project bersama, saya ingin menjalani prosesnya sendiri untuk melihat bagian mana yang saya lewatkan. Dan gunakan pengetahuan tersebut untuk menyederhanakan dokumen lebih lanjut.
Terakhir, meskipun saya hanya membahas satu project di sini, saya rasa ini tidak akan memakan waktu lebih dari beberapa minggu. Seperti yang telah dibahas dalam korespondensi email kita, saya rasa kita dapat mengerjakan beberapa project selama kita bersama.