Memulai¶

Panduan setup environment untuk berkontribusi pada Garudea Docs.

Prasyarat¶

Python 3.12+ — MkDocs berbasis Python
Git — Untuk clone dan push ke repository
Text Editor — VS Code direkomendasikan

Clone Repository¶

git clone https://repo.nusatek.id/garudea/docs.git
cd docs

Install Dependencies¶

pip install mkdocs-material mkdocs-glightbox mkdocs-minify-plugin

Jalankan Secara Lokal¶

mkdocs serve

Buka browser di http://localhost:8000 untuk melihat preview dokumentasi.

Live Reload

mkdocs serve otomatis me-reload halaman setiap kali ada perubahan file. Tidak perlu restart server.

Struktur Repository¶

docs/                          # Root repository
├── mkdocs.yml                 # Konfigurasi utama MkDocs
├── Dockerfile                 # Build image untuk deployment
├── .gitlab-ci.yml             # Pipeline CI/CD
├── dokumentasi/               # Dokumentasi internal (tidak tampil di site)
└── docs/                      # Konten dokumentasi (tampil di site)
    ├── index.md               # Landing page
    ├── erp/                   # App: Garudea Enterprise System
    ├── pembantu/              # App: Pembantu
    ├── odoo-modules/          # App: Odoo Modules
    ├── panduan/               # Panduan penggunaan Garudea Docs
    ├── references/            # About & Release Notes
    └── assets/                # CSS, gambar, logo
        ├── stylesheets/
        └── images/

Folder dokumentasi/

Folder dokumentasi/ berada di root repo (di luar docs/), sehingga tidak tampil di site publik. Gunakan folder ini untuk catatan internal, planning, dan maintenance notes.