Lewati ke isi

Struktur & Navigasi

Panduan mengatur struktur file dan menambahkan halaman atau aplikasi baru di Garudea Docs.

Konsep Navigasi

Garudea Docs menggunakan arsitektur multi-app dengan 2 level navigasi:

Level Elemen Contoh
Level 1 — Tabs Aplikasi / produk ERP, Pembantu, Odoo Modules
Level 2 — Sidebar Bagian dalam aplikasi Accounting, HRIS, Inventory 
[Home] [Garudea Enterprise System] [Pembantu] [Odoo Modules] [Panduan] [References]
  ↑ Tabs (Level 1)

Sidebar (Level 2):
├── Getting Started
├── Accounting
│   ├── Konfigurasi
│   └── Panduan Pengguna
├── HRIS
│   ├── Konfigurasi HR
│   └── Panduan Pengguna
└── ...

Menambahkan Halaman Baru

1. Buat file .md

Buat file markdown baru di folder yang sesuai:

# Contoh: menambah halaman di modul Accounting ERP
touch docs/erp/accounting/user/laporan-keuangan.md

2. Tulis konten

# Laporan Keuangan

Panduan untuk membuat dan melihat laporan keuangan.

## Neraca

...

3. Tambahkan ke mkdocs.yml

Buka mkdocs.yml dan tambahkan entry di bagian nav: sesuai posisi yang diinginkan:

    - Accounting:
      - erp/accounting/index.md
      - 'Konfigurasi': erp/accounting/admin/accounting_config.md
      - 'Panduan Pengguna': erp/accounting/user/accounting.md
      - 'Laporan Keuangan': erp/accounting/user/laporan-keuangan.md  # BARU

4. Preview

mkdocs serve

Halaman baru akan muncul di sidebar.

Menambahkan Aplikasi Baru

1. Buat folder

mkdir -p docs/nama-app

2. Buat index.md

cat > docs/nama-app/index.md << 'EOF'
# Nama Aplikasi

Deskripsi singkat tentang aplikasi ini.
EOF

3. Tambahkan ke mkdocs.yml

Tambahkan entry baru di nav: sebagai top-level item. Posisikan sebelum References:

nav:
  - Home:
    - index.md
  - Garudea Enterprise System:
    - erp/index.md
    - ...
  - Nama Aplikasi:              # TAB BARU
    - nama-app/index.md
  - References:
    - references/index.md
    - ...

4. Build & test

mkdocs serve

Tab baru akan muncul di navigation bar.

Menambahkan Modul Odoo Baru

Dokumentasi Odoo Modules distrukturkan per modul:

1. Buat folder modul

mkdir -p docs/odoo-modules/nama-modul

2. Buat index.md modul

# Nama Modul Odoo

Deskripsi singkat tentang modul ini.

## Instalasi

Cara install modul ini di Odoo.

## Konfigurasi

Setting awal yang diperlukan.

## Penggunaan

Panduan penggunaan fitur-fitur modul.

3. Tambahkan ke mkdocs.yml

  - Odoo Modules:
    - odoo-modules/index.md
    - 'Nama Modul': odoo-modules/nama-modul/index.md    # BARU

4. Tambahkan screenshot (opsional)

Simpan screenshot di folder yang sama:

docs/odoo-modules/nama-modul/
├── index.md
├── install.png
├── config.png
└── usage.png

Struktur mkdocs.yml

File mkdocs.yml adalah konfigurasi utama. Bagian yang paling sering diedit adalah nav:.

Format Nav

nav:
  - 'Label Tampil': path/ke/file.md

Hierarki Nav

nav:
  - Tab Name:                          # Level 1: Tab
    - folder/index.md                  # Section index
    - Section Name:                    # Level 2: Sidebar group
      - folder/sub/index.md
      - 'Page Name': folder/sub/page.md    # Level 3: Page

Tips

Path file relatif terhadap docs/

Semua path di nav: relatif terhadap folder docs/. Jadi erp/index.md sebenarnya adalah docs/erp/index.md.

Jangan lupa index.md

Setiap folder yang jadi section harus punya index.md agar fitur section index pages berfungsi dengan baik.

Mengatur Urutan Halaman

Urutan halaman di sidebar mengikuti urutan di nav: pada mkdocs.yml. Untuk mengubah urutan, cukup pindahkan baris di nav:.

# Urutan di sidebar akan sesuai urutan ini:
- Accounting:
  - erp/accounting/index.md
  - 'Konfigurasi': erp/accounting/admin/accounting_config.md      # Tampil pertama
  - 'Panduan Pengguna': erp/accounting/user/accounting.md          # Tampil kedua
  - 'Laporan Keuangan': erp/accounting/user/laporan-keuangan.md   # Tampil ketiga