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 → 04 Arsitektur
2. Mau setup laptop → 07 Setup lokal
3. Mau deploy Space → 08 Deploy HF Space
4. Sedang hackathon → 13 Timeline + 14 Submit
5. Cursor / AI agent → ONEIROS_CURSOR_CONTEXT.md di root

---

Daftar isi

Produk & konteks

#	Dokumen	Deskripsi
01	Ringkasan proyek	Apa itu Oneiros, MVP, diferensiasi
02	Hackathon	Event, aturan, track, bonus quest
03	Positioning & privasi	Space vs lokal, narasi untuk judge

Teknis

#	Dokumen	Deskripsi
04	Arsitektur	Struktur folder, alur data, diagram
05	Skema JSON	Format ekstraksi mimpi, enum, contoh
06	Referensi modul	Kontrak API tiap modul Python
07	Setup lokal	Instalasi, env, download model
08	Deploy HF Space	Wheel, preload, YAML, debug
09	Panduan pengembangan	Workflow, prompt, normalisasi
10	Testing	Test extractor, generator, E2E
11	Agent trace	Logging untuk bonus 📡
12	UI & Gradio	Layout, CSS, komponen

Operasional hackathon

#	Dokumen	Deskripsi
13	Timeline hackathon	Day 0–5, gate, checklist harian
14	Submit & bonus	Video, README, sosial, blog
15	Risiko & mitigasi	Kegagalan umum & solusi
16	Checklist sebelum Day 2	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.

---

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).