Lewati ke konten
Corsace Documentation
DiscordGitHubTwitchTwitterYouTube

Dokumentasi - Menulis/Menyuting Dokumen

Pastikan bahwa kamu telah membuat fork, karena kami menerima kontribusi melalui pull request dari fork repositori.

Bacaan Prasyarat

Struktur Direktori

Pada repositori ini, seluruh dokumentasi yang dihasilkan akan dapat ditemui pada Docs/src/content/docs/en.
Folder docs ini juga mengandung dokumentasi dalam berbagai bahasa yang pada umumnya diterjemahkan dari folder en.
Apabila kamu ingin membantu menerjemahkan, mintalah akses sebagai penerjemah pada https://translate.corsace.io dan bergabunglah ke server Discord Corsace

Dokumen yang akan kamu buat harus ditempatkan pada Docs/src/content/docs/en atau salah satu sub-folder di dalamnya.
Struktur direktori yang dimiliki oleh folder ini serupa dengan struktur direktori yang tertera pada sidebar.
Secara garis besar, dokumentasi proyek ini terbagi menjadi 3 bagian utama:

Proyek ini menggunakan framework Diátaxis digunakan sebagai panduan umum untuk menulis dokumen. Meskipun demikian, kamu hanya perlu untuk memahami cara untuk menulis Panduan dan Referensi untuk dapat berkontribusi. The Running Tournaments and Playing Tournaments sections only contain guides, as any references needed are/will be within this Development section.

Anatomi Dokumen

Dokumentasi ini ditulis dengan asumsi bahwa kamu telah memahami cara kerja markdown beserta dengan berbagai fitur penulisan tambahan yang disediakan oleh Starlight sebagaimana yang tertera pada Bacaan Prasyarat.

Kamu disarankan untuk menyimpan berkas dokumentasimu dalam format .mdx agar ke depannya dokumentasi ini dapat terintegrasi dengan kode Javascript/JSX.

Untuk dokumen yang statusnya masih dalam pengerjaan (WIP) atau yang tidak dibuat untuk dihubungkan ke dokumen lainnya, lihat bagian Dokumen WIP.

Penamaan Berkas

Namai dokumen kamu sesuai dengan judul dokumen yang ditulis dengan huruf kecil dan tanda strip - sebagai pengganti spasi. Sebagai contoh, pada dokumen yang berjudul Docs - Write/Edit Documents ini, nama berkas yang sesuai adalah docs-write-edit-documents.mdx.

Kop Dokumen (Frontmatter)

Pada umumnya, suatu dokumen harus menyertakan berbagai keterangan berikut pada bagian kop-nya:

  • title - Judul dokumen yang bersangkutan
  • description - Penjelasan singkat seputar kegunaan dokumen
  • lastUpdated - Tanggal dokumen terakhir dibuat/diperbarui dalam format YYYY-MM-DD
  • sidebar
    • order - Ordo/tingkatan dokumen. Semakin rendah angka yang tertera, semakin awal dokumen akan terurut pada sidebar.
    • Catatan: Pengurutan sub-dokumen dilangsungkan dengan sistem angka 4 digit. Sistem ini serupa dengan sistem ID untuk dokumen utama.

Sebagai contoh, berikut merupakan kop yang digunakan oleh dokumen ini:

---
title: Docs - Write/Edit Documents
description: Writing/Editing documentation for Corsace
lastUpdated: 2023-09-17
sidebar:
    order: 1110
---

Badan Dokumen

Seluruh header pada badan dokumen harus ditulis dengan diawali oleh setidaknya 2 simbol tagar ## untuk dapat muncul.
Astro Starlight akan secara otomatis membuat ## Overview untuk setiap dokumen baru, sehingga kamu tidak perlu membuat header tambahan untuk teks perkenalan.

Apabila dokumentasi kamu bergantung pada dokumen lain pada repositori ini atau pada Astro Starlight, pastikan untuk menambahkan bagian ## Bacaan Prasyarat setelah teks perkenalan NAMUN sebelum bagian lainnya yang kamu buat.

Gambar

Images should be put in the Docs/src/images directory with words lowercased and separated by underscores. Kamu akan dapat menyisipkan gambar-gambar ini ke dokumenmu melalui tautan relatif (relative link). To access an image in Docs/src/images from this file (which is at Docs/src/content/docs/en/development/Client/Guide/docs-write-edit-documents.mdx), you require the following relative direction:

![Example Image](../../../../../../images/development/example_image.png)

Dengan masing-masing tanda ../ digunakan untuk naik satu folder.

Variabel

Apabila kamu perlu untuk menyisipkan variabel tertentu, kamu dapat menuliskannya sebagai [VARIABLE].

Sebagai contoh, pada parameter config.[SITE].host, SITE merupakan variabel yang merujuk pada host situs yang bersangkutan.

Dokumen WIP

Berhubung Corsace merupakan repositori yang senantiasa berkembang dengan berbagai elemen yang terus-menerus dipindahkan dan dikerjakan, repositori Corsace tak pelak akan memiliki banyak dokumentasi yang tidak dapat diselesaikan sepenuhnya.

Pada kasus yang seperti ini, kamu akan perlu untuk menambahkan berbagai fitur berikut ke dalam dokumenmu:

Kop Dokumen WIP

Pada kop dokumenmu, tambahkan kode berikut pada bagian sidebar:

  badge:
    text: WIP
    variant: caution

Sebagai contoh, apabila dokumen ini merupakan dokumen WIP, maka kodenya adalah:

---
title: Docs - Write/Edit Documents
description: Writing/Editing documentation for Corsace
lastUpdated: 2023-09-17
sidebar:
    badge:
        text: WIP
        variant: caution
    order: 1110
---

Kode ini akan menampilkan ikon WIP pada dokumen di sidebar sebagai berikut:
Contoh badge WIP

Bagian WIP

Apabila terdapat bagian tertentu pada dokumen yang masih dalam pengerjaan, kamu harus membuat komponen bernama WorkInProgress di dalam folder Docs/src/components untuk menandai bagian ini sebagai WIP.
Kamu harus mengimpor komponen ini SETELAH bagian kop dokumen, namun SEBELUM kamu menempatkan teks apapun. Untuk mengimpor, panggil komponen menggunakan tautan relatif sebagaimana ketika kamu ingin menampilkan gambar.
Sebagai contoh, pada dokumen ini, kode untuk mengimpor komponen adalah:

---
title: Docs - Write/Edit Documents
description: Writing/Editing documentation for Corsace
lastUpdated: 2023-09-17
sidebar:
    badge:
        text: WIP
        variant: caution
    order: 1110
---
import WorkInProgress from '../../../../../../components/WorkInProgress.astro';

## Prerequisite Reading

Setelahnya, kamu dapat menempatkan komponen yang kamu impor pada bagian manapun yang ingin kamu tandai WIP sebagai berikut:

<WorkInProgress section="section/name" />

Yang akan terlihat seperti:

The following section section/name is currently under construction.