starknet docs

Repositori Dokumentasi StarkNet

Situs web StarkNet Docs, https://docs.sarknet.io, ditulis dalam ASCIIDOC dan dibangun menggunakan Antora, generator situs web statis untuk ASCIIDOC.

Berkontribusi pada dokumentasi StarkNet

Jika Anda tertarik untuk berkontribusi pada dokumentasi teknis StarkNet, tabel berikut menyediakan tautan cepat untuk membantu Anda memulai.

Pertanyaan	Sumber
Saya tertarik, bagaimana cara berkontribusi?	Untuk informasi tentang bagaimana Anda dapat berkontribusi, lihat berbagai cara untuk berkontribusi.
Apakah ada pedoman dasar untuk membantu saya?	Untuk pedoman dasar untuk membantu kami menjaga konten kami konsisten, lihat pedoman dokumentasi.
Apakah ada panduan gaya dan panduan penulisan yang harus saya gunakan?	Lihat Panduan Gaya Tambahan Dokumentasi StarkNet.
Bagaimana cara mengatur stasiun kerja saya?	Lihat Menyiapkan Lingkungan Anda.

Berbagai cara untuk berkontribusi

Ada beberapa cara berbeda yang dapat Anda berkontribusi pada dokumentasi StarkNet:

• Buat masalah GitHub.

• Kirim Permintaan Tarik (PR). Anda dapat membuat klon lokal dari garpu Anda sendiri dari repositori Starknet-Docs, membuat perubahan Anda, dan mengirimkan PR. Opsi ini adalah yang terbaik jika Anda memiliki perubahan besar, atau untuk membantu perubahan yang ingin Anda tambahkan lebih cepat.

Apa yang terjadi saat Anda mengirimkan PR?

Saat Anda mengirimkan PR, tim StarkNet Docs mengulas PR dan mengatur ulasan teknis lebih lanjut seperlunya. Jika PR membutuhkan perubahan, pengulas menambahkan komentar ke PR. Kami mungkin meminta Anda melakukan perubahan, atau memberi tahu Anda bahwa kami memasukkan konten Anda dalam PR yang berbeda. Kadang -kadang, kami dapat menambahkan komit ke PR asli secara langsung. Ketika PR telah ditinjau dan semua pembaruan selesai, tim dokumentasi menggabungkan PR dan menerapkannya pada versi yang valid.

Tips tentang penulisan

• Starknet Dokumentasi Panduan Gaya Tambahan: Panduan Gaya Umum dan Panduan Menulis.

Untuk informasi tentang penulisan di ASCIIDOC, lihat:

• Dokumentasi Bahasa Asciidoc

• Referensi Cepat Sintaks Asciidoc

Catatan

Ada beberapa cara pengkodean ID, blok kode sumber, referensi silang, dan tautan. Secara umum kami menggunakan konvensi pengkodean paling eksplisit untuk pengkodean untuk memprioritaskan keterbacaan kode. Sebagian besar konvensi pengkodean ini tercantum dalam Referensi Cepat Mark-Up Asciidoc untuk Dokumentasi Red Hat

Sebelum Anda mulai

1. Instal yarn jika belum diinstal.

2. Instal npx jika belum diinstal.

3. Klone repo ini, baik dari garpu, atau jika Anda adalah kolaborator resmi, maka langsung dari starknet-io/starknet-docs .

4. Ubah ke direktori starknet-docs .

5. Jalankan perintah yarn untuk mempersiapkan lingkungan:

    benang

yarn harus menyiapkan lingkungan Anda dengan menginstal modul yang diperlukan berdasarkan package-lock.json dan package.json . Jika berhasil, Anda harus dapat membangun dan mempratinjau konten.

Membangun dan melihat pratinjau konten secara lokal

Setelah menulis atau mengedit konten, untuk melihat pratinjau perubahan Anda:

1. Bangun konten dengan menjalankan skrip build_local_site.sh :

   ./build_local_site.sh

   Perintah ini menghasilkan situs web di direktori public_html .

2. Buka situs web dengan melakukan salah satu dari yang berikut:

   • Buka halaman Mulai: <repo_root>/public_html/index.html .

   • Jalankan server HTTP yang dikemas dengan Antora:

     npx http-server public_html -c-1

     Server berjalan, dan memberi Anda satu atau lebih URL lokal yang dapat Anda gunakan untuk melihat situs web. Misalnya:

     Starting up http-server, serving public_html
     
     ...
     
     Available on:
       http://127.0.0.1:8080
       http://192.168.68.111:8080
       http://192.168.14.3:8080
       http://10.14.0.2:8080
     Hit CTRL-C to stop the server

Merilis starknet docs di github (hanya untuk admin)

Proses tingkat tinggi untuk merilis perubahan dokumentasi dalam repositori ini.

Selama pengembangan konten, penulis menggabungkan cabang dengan perubahan baik secara langsung menjadi main , menjadi cabang sekunder sesuai kebutuhan, di mana perubahan ini menunggu sampai kita siap untuk melepaskannya - yaitu, kirimkan mereka ke docs.starknet.io.

Tindakan GitHub Buat tag dan rilis GIT yang muncul di rilis dan tag Repo.

Ketika cabang fitur digabungkan ke cabang main , tindakan GitHub membuat tag rilis dalam format v<version>.<major_update>.<minor_update> dan memperbarui CHANGELOG.md . Kemudian menerbitkan konten baru ke docs.sarknet.io.

Prosedur

Menggabungkan cabang fitur ke main secara otomatis menerbitkan perubahan dalam cabang fitur. Tidak ada langkah tambahan yang diperlukan.

GitHub menambah nomor versi dalam package.json dan package-lock.json , dan memperbarui CHANGELOG.md dengan deskripsi setiap PR yang baru saja digabung menjadi main . . Perbarui cabang main lokal Anda dari cabang main jarak jauh menggunakan salah satu dari yang berikut:

• Tarik perubahan:

  starknet-docs (main) git pull

• Lakukan Rebase dari [email protected]:starknet-io/starknet-docs.git :

  starknet-docs (main) git fetch origin
  starknet-docs (main) git rebase origin/main

  Catatan

  Jika Anda menggunakan garpu, maka repo forked Anda origin dari default, dalam hal ini Anda harus menetapkan nama upstream ke [email protected]:starknet-io/starknet-docs.git . Jadi saat rebasing, gunakan upstream alih -alih origin pada perintah di atas.