docs/README.md

# Dokumentasi Oneiros

Dokumentasi resmi proyek **Oneiros** — dream cartography dengan model kecil (≤32B) dan Gradio.

**Terakhir diperbarui:** 1 Juni 2026

---

## Cara membaca

1. **Baru di proyek** → [01 Ringkasan](01-ringkasan-proyek.md) → [04 Arsitektur](04-arsitektur.md)
2. **Mau setup laptop** → [07 Setup lokal](07-setup-lokal.md)
3. **Mau deploy Space** → [08 Deploy HF Space](08-deploy-hf-space.md)
4. **Sedang hackathon** → [13 Timeline](13-timeline-hackathon.md) + [14 Submit](14-submit-dan-bonus.md)
5. **Cursor / AI agent** → [`ONEIROS_CURSOR_CONTEXT.md`](../ONEIROS_CURSOR_CONTEXT.md) di root

---

## Daftar isi

### Produk & konteks

| # | Dokumen | Deskripsi |
|---|---------|-----------|
| 01 | [Ringkasan proyek](01-ringkasan-proyek.md) | Apa itu Oneiros, MVP, diferensiasi |
| 02 | [Hackathon](02-hackathon.md) | Event, aturan, track, bonus quest |
| 03 | [Positioning & privasi](03-positioning-dan-privasi.md) | Space vs lokal, narasi untuk judge |

### Teknis

| # | Dokumen | Deskripsi |
|---|---------|-----------|
| 04 | [Arsitektur](04-arsitektur.md) | Struktur folder, alur data, diagram |
| 05 | [Skema JSON](05-skema-json.md) | Format ekstraksi mimpi, enum, contoh |
| 06 | [Referensi modul](06-modul-referensi.md) | Kontrak API tiap modul Python |
| 07 | [Setup lokal](07-setup-lokal.md) | Instalasi, env, download model |
| 08 | [Deploy HF Space](08-deploy-hf-space.md) | Wheel, preload, YAML, debug |
| 09 | [Panduan pengembangan](09-pengembangan.md) | Workflow, prompt, normalisasi |
| 10 | [Testing](10-testing.md) | Test extractor, generator, E2E |
| 11 | [Agent trace](11-agent-trace.md) | Logging untuk bonus 📡 |
| 12 | [UI & Gradio](12-ui-dan-gradio.md) | Layout, CSS, komponen |

### Operasional hackathon

| # | Dokumen | Deskripsi |
|---|---------|-----------|
| 13 | [Timeline hackathon](13-timeline-hackathon.md) | Day 0–5, gate, checklist harian |
| 14 | [Submit & bonus](14-submit-dan-bonus.md) | Video, README, sosial, blog |
| 15 | [Risiko & mitigasi](15-risiko-dan-mitigasi.md) | Kegagalan umum & solusi |
| 16 | [Checklist sebelum Day 2](16-checklist-sebelum-day2.md) | Space Running, shard, gate |

---

## Diagram alur (ringkas)

```
Mimpi (teks) → extractor (Qwen + llama.cpp) → JSON
      → normalisasi → generator → SVG
      → format_panel → Markdown
      → trace_logger → JSONL (tanpa teks mimpi) → HF Dataset
```

Detail: [04 Arsitektur](04-arsitektur.md).

---

## File di luar `docs/`

| File | Peran |
|------|------|
| `ONEIROS_CURSOR_CONTEXT.md` | Konteks padat untuk Cursor (spes + snippet) |
| `README.md` | Pintu masuk repo + link docs |
| `app.py`, `model/`, … | Kode aplikasi (akan ditambahkan saat implementasi) |

---

## Konvensi dokumentasi

- Istilah produk dalam bahasa Inggris (Oneiros, Space, Gradio) tetap asli.
- Penjelasan proses dan checklist dalam **bahasa Indonesia**.
- Kode dan nama file mengikuti repo (`snake_case` untuk modul Python).
- Variabel **baru** di kode harus bahasa Indonesia (lihat [09 Pengembangan](09-pengembangan.md)).