iota wiki

Jelajahi wiki

Laporkan Kesalahan · Minta topik

Daftar isi

• Tentang proyek
  • Dibangun dengan
• Memulai
  • Prasyarat
  • Pengembangan Lokal
• Berkontribusi
• Kontak

Tentang proyek

Iota Wiki adalah pusat pusat untuk memasuki ekosistem IOTA. Inisiatif yang didorong oleh komunitas untuk memberikan koleksi perkenalan terkini dan bacaan lebih lanjut tentang teknologi, tim, komunitas, dan segala sesuatu di antaranya. Jadi siapa pun dapat belajar cara membangun, mengadopsi, dan terlibat dengan IOTA, semuanya dalam satu ruang.

Dibangun dengan

Wiki IOTA dibangun menggunakan TypeScript, ReactJs dan Docusaurus v2.0.

Memulai

Prasyarat

• git 1.8.2 atau lebih.
• Node.js 16.10 atau lebih.
• Benang modern diaktifkan dengan menjalankan corepack enable .

Pratinjau secara lokal

Untuk melihat pratinjau wiki secara lokal, gunakan langkah -langkah berikut. Untuk skrip yang lebih rinci, lihat skrip yang dikonfigurasi sebelumnya untuk referensi.

Harap dicatat bahwa wiki memiliki banyak konten, jadi saat ini bangunan awal memakan waktu. Upaya dilakukan untuk mencoba dan mengurangi waktu pembangunan di masa depan.

1. Kloning Repositori dengan Menjalankan git clone https://github.com/iotaledger/iota-wiki.git dan pergi ke direktori dengan cd iota-wiki .
2. Pasang dependensi dengan yarn .
3. Persiapkan lingkungan dengan menjalankan yarn prepare , ini harus dilakukan hanya sekali.
4. Pratinjau wiki dengan yarn start , ini akan memulai server pengembangan yang menyajikan wiki dengan kemampuan memuat ulang panas, sehingga akan memperbarui konten setelah perubahan apa pun dilakukan.

Skrip yang telah dikonfigurasi sebelumnya

Naskah	Penjelasan
prepare	Siapkan lingkungan dengan memeriksa submodules build.
start	Mulailah server pengembangan yang melayani wiki, dengan pemuatan ulang panas pada perubahan.
start:section:{section}	Mulailah server pengembangan yang hanya melayani bagian wiki, dengan pemuatan ulang panas pada perubahan. Bagian yang tersedia adalah build , get-started , learn , dan maintain .
build	Bangun wiki. Untuk membangun untuk produksi, checkout versi terbaru dari dokumentasi eksternal dengan menjalankan yarn checkout:remote dan atur variabel lingkungan MODE ke production .
checkout:remote	Lihat versi terbaru dari dokumentasi eksternal.
generate:api	Hasilkan dokumentasi API yang tersedia yang dikonfigurasi melalui plugin Docusaurus OpenAPI dan dengan menyusun dokumentasi dari kode sumber.

Berkontribusi

Wiki IOTA dikelola oleh kontribusi IF dan komunitas selalu diterima. Tim DX dan tim terkait dari IF akan meninjau semua masalah dan menarik permintaan yang diposting ke repositori ini. Jika Anda melihat kesalahan, atau merasakan ada sesuatu yang hilang, jangan ragu untuk membuat masalah untuk didiskusikan dengan tim atau secara langsung membuat permintaan tarik dengan saran. Berikut ini adalah alur kerja dasar untuk membuka permintaan tarik:

1. Fork Repositori ini ke akun Anda sendiri dan klon ( git clone https://github.com/<YOUR_USERNAME>/iota-wiki.git )
2. Buat cabang fitur untuk perubahan Anda ( git checkout -b feat/amazing-feature ).
3. Buat perubahan Anda dan secara opsional pratinjau secara lokal.
4. Jalankan yarn format dan yarn lint dan perbaiki kesalahan dan peringatan yang tersisa.
5. Komit perubahan Anda ( git commit -m 'Add some amazing feature' ).
6. Dorong perubahan Anda ke garpu Anda ( git push origin feat/amazing-feature ).
7. Buka permintaan tarik ke cabang main repositori ini.

Lihat berkontribusi untuk panduan lebih lanjut.

Versi

Untuk mengetahui cara versi dokumen Anda, baca panduan ini.

Pengaturan satu klik online untuk berkontribusi

Anda dapat menggunakan GITPOD (IDE GRATIS, Online, VS Code-Like) untuk berkontribusi. Dengan satu klik itu akan menyiapkan semua yang Anda butuhkan untuk membangun dan berkontribusi pada wiki. Cukup klik tombol ini dan lewati langkah 1 dari atas.

Kontak

Phylo - Phyloiota - Phylo [Community Dao - Lets Go!]#2233
Jeroen Van den Hout - Jlvandenhout - JVDHout#4402
Dr.electron - DR -Electron - Dr.electron#9370
Critical - Kilianhln - Critical#7111
JSTO - JSTO91 - JSTO#3746