Skip to content

Memperbarui handbook ​

Saat aturan berubah ​

  1. Simpan file sumber baru atau versi revisi di luar docs/, dengan nama yang menunjukkan asal/tanggal bila tersedia. Jangan menimpa sumber lama sebelum perbedaannya dicatat.
  2. Baca seluruh sumber, termasuk tabel, gambar, screenshot, dan catatan versi. Tentukan wilayah serta periode berlakunya.
  3. Ubah halaman topik di docs/operations/, docs/class/, docs/teaching/, atau docs/courses/. Tambahkan path serta baris/halaman yang benar pada bagian Rujukan asli halaman ini di akhir halaman. Biarkan bagian itu tertutup agar langkah utama mudah dibaca. Bila dua sumber berbeda, tulis keduanya di pertanyaan terbuka.
  4. Untuk aturan penting, cek ulang contoh kasus, checklist, FAQ, dan referensi cepat agar tidak menyisakan instruksi lama.
  5. Jalankan python scripts/generate_source_catalog.py untuk memperbarui daftar file, lalu npm run docs:build untuk memeriksa build dan tautan.

Menambah chapter ​

  1. Buat satu folder/topik baru di docs/ dan halaman Markdown per kebutuhan pengguna. Mulai dari index.md bila ada beberapa subhalaman.
  2. Tambahkan halaman pada satu daftar sidebar dalam docs/.vitepress/config.mts; hanya tautkan halaman yang benar-benar ada. Untuk bab pedagogi, tambahkan tautan dari docs/teaching/index.md juga.
  3. Tautkan dari halaman induk, referensi cepat, atau FAQ bila kasusnya sering dicari.
  4. Untuk Practice Teaching nanti, buat docs/teaching/practice-teaching/ atau kategori sejajar setelah resource-nya diaudit; struktur operasional tidak perlu dipindah.
  5. Bangun dan periksa tampilan desktop/mobile melalui npm run docs:dev.

Cara menulis aturan ​

Sebut apa, kapan, urutan, pengecualian, bukti, eskalasi, dan sumber. Bedakan Official Rule, Official Procedure, Recommended Practice, Personal Note, dan Unverified. Jangan menyimpulkan sanksi, pembayaran, durasi, atau persetujuan yang tidak dinyatakan oleh sumber. Kutip baris Markdown atau halaman PDF yang benar-benar dapat ditemukan.

Gambar dan privasi ​

Simpan sumber asli di luar docs/. Masukkan hanya gambar yang membantu memahami antarmuka/proses, setelah memeriksa identitas, email, nomor telepon, kredensial, atau karya Student. Salin ilustrasi yang aman ke docs/public/illustrations/; tulis informasi penting dari gambar sebagai teks agar dapat dicari. Jangan mengunggah video/recording kelas atau screenshot Student ke repo dokumentasi.

Menjalankan lokal ​

powershell
npm install
npm run docs:dev

Build dan preview:

powershell
npm run docs:build
npm run docs:preview

Situs ini ditandai private pada package.json dan mempunyai meta noindex; itu bukan kontrol akses. Bila suatu hari perlu hosting, siapkan autentikasi/akses privat dan lakukan review data terlebih dahulu.

Dokumentasi kerja pribadi. Verifikasi perubahan kebijakan dengan tim Algonova.