Kontribusikan pada dokumentasi Weblate

Silakan sempurnakan halaman dokumentasi pilihan Anda. Anda dapat melakukannya dengan mudah dengan mengeklik tombol Sunting di GitHub di pojok kanan atas halaman.

Pedoman dokumentasi

Harap hormati pedoman berikut saat menulis:

  1. Jangan hapus bagian dari dokumentasi jika valid.

  2. Gunakan bahasa yang jelas dan mudah dipahami. Anda sedang menulis dokumen teknis, bukan puisi. Tidak semua pembaca dokumen adalah penutur asli, jadi berhati-hatilah.

  3. Jangan ragu untuk bertanya jika Anda tidak yakin. Jika Anda perlu bertanya tentang suatu fitur saat menyunting, jangan ubah dokumennya sebelum Anda mendapatkan jawabannya. Artinya: Anda mengubah atau bertanya. Jangan lakukan keduanya secara bersamaan.

  4. Verifikasikan perubahan Anda dengan melakukan tindakan yang dijelaskan saat mengikuti dokumen.

  5. Kirim PR dengan perubahan dalam potongan kecil agar lebih mudah dan cepat dalam meninjau dan menggabungkan.

  6. Jika Anda ingin menulis ulang dan mengubah struktur artikel besar, lakukan dalam dua langkah:

    1. Tulis kembali

    2. Setelah tulisan ulang ditinjau, dipoles, dan digabungkan, ubah struktur paragraf dalam PR lain.

Membangun dokumentasi secara lokal

Documentation can be also edited and built locally, the Python requirements are in the docs dependency group in pyproject.toml. If you already use the full development environment, uv sync --all-extras --dev is enough. For documentation work only, uv sync --group docs is sufficient.

The recommended local workflow is:

make -C docs update-docs
./ci/run-docs

The ci/run-docs wrapper builds the documentation with warnings treated as errors.

Petunjuk

Anda juga perlu memasang graphviz untuk membangun dokumentasi.

Menerjemahkan dokumentasi

Anda dapat menerjemahkan dokumen.

Updating generated documentation snippets

Several documentation sections use templates generated from the code. The preferred way to refresh them is:

make -C docs update-docs

This target regenerates the snippets currently used by the documentation, including:

  • add-on events, built-in add-ons, and common add-on parameters

  • machine translation services

  • file format parameters and file format feature tables

  • permissions and built-in roles

  • checks and check flags

Keep manually maintained text in the parent documentation page rather than adding it to autogenerated snippets. For example, Pengaya includes three generated files for events, built-in add-ons, and common add-on parameters, while obsolete add-ons are maintained directly in the page.

If you need to regenerate only one part, the individual management commands are documented in Perintah pengelolaan, and the exact commands used by update-docs are listed in docs/Makefile.