Menulis halaman Exsport
Cara menambah atau memperbarui halaman di bagian ini. Aturannya membuat setiap halaman tetap bisa ditemukan dan bisa dicek kadaluarsanya nanti. Aturan ini sama dengan panduan kontribusi INACT; bedanya Exsport adalah satu produk di banyak repo, bukan satu codebase yang di-fork per klien.
Sebelum menulis
- Cek kodenya, bukan ingatanmu. Setiap klaim yang tidak jelas menunjuk ke sebuah file, entity, env var atau resolver. Kalau tidak bisa menunjuknya, tulis baris
> **TODO:**daripada menebak. Halaman tipis yang jujur lebih baik daripada halaman penuh dengan tiga baris salah. - Sebutkan repo-nya. Sebuah fitur biasanya membentang di backend + satu frontend. Sebutkan repo untuk setiap file yang kamu kutip (
def-exsport-backend,def-exsport-frontend-storefront,def-exsport-frontend-admin). - Cek bahwa jalurnya hidup. Ada yang ada tetapi tidak terhubung: create product/journal/voucher itu REST, bukan GraphQL mutation (yang di-comment-out); admin dashboard itu stub; admin orders tidak punya mutation. Katakan begitu.
- Kedua locale, setiap kali. Bahasa Inggris di bawah
src/exsport/, Bahasa Indonesia di bawahsrc/id/exsport/, struktur sama, dan entri sidebar di kedua locale disrc/.vitepress/config.mjs. Sebuah halaman belum selesai sampai keduanya ada.
Frontmatter-nya
---
last_verified: 2026-09-15
verified_on: [def-exsport-backend, def-exsport-frontend-storefront]
sources:
- src/orders/services/orders.service.ts
- src/app/checkout/shipping/page.tsx
---verified_on mencantumkan repo tempat klaim dicek, berdasarkan slug GitHub. sources adalah jalur relatif-repo; karena Exsport membentang di banyak repo, source sebuah halaman bisa datang dari lebih dari satu repo. Tool staleness mencocokkan setiap source terhadap setiap repo Exsport yang dikonfigurasi dan melaporkan mana yang berubah. Perbarui last_verified setiap kali kamu mengecek ulang halaman.
Bagian-bagiannya, dalam urutan ini
Untuk halaman fitur:
- Ikhtisar singkat: apa fiturnya, backend module mana dan frontend mana.
- Kotak
::: info How this page was verified: kapan, repo mana, apa yang dibaca. - Model: entity/tabel yang terlibat (namanya adalah
@Entity({ name })). - Backend: resolver (CMS vs
front*), REST controller, service, panggilan pihak ketiga. - Storefront dan/atau Admin: route dan file di baliknya.
- Gotcha: jalur mati, write REST-bukan-GraphQL, efek simulator, side-effect event.
- Terkait: halaman tetangga.
Untuk halaman sistem (environment, database, API, pihak ketiga) sesuaikan heading-nya; pertahankan kotak verifikasi dan gotcha. Untuk halaman repo, ikuti delapan yang sudah ada: stack, run, layout, fakta struktural, model branch.
Menandai hal sekali-jalan
::: warning Storefront only
The cart is a context, not a `/cart` route.
:::Pakai ::: danger untuk sesuatu yang gagal atau menyesatkan, ::: warning untuk perbedaan, ::: tip untuk bantuan baca.
Bahasa
Halaman Bahasa Inggris dulu, lalu halaman Bahasa Indonesia. Istilah domain dan teknis tetap Bahasa Inggris di keduanya: GraphQL, resolver, entity, cart, checkout, voucher, flash sale, webhook, dan setiap nama tabel, kolom, fungsi dan env-var. Kalimat pendek. Sampaikan poin utama dulu.
Mengecek halaman nanti
Jalankan tool staleness (scripts/doc-staleness.py exsport, atau filter repo seperti exsport backend) untuk melihat halaman mana yang tertinggal dari kode, lalu buka kodenya, pastikan setiap klaim, perbaiki teksnya, dan naikkan last_verified. Skill update-docs membungkus ini.