Skip to content

csku-ai/docs

Repository files navigation

CSKU AI Documentation

Documentation for CSKU AI Public API and Webhooks.

Cara Deploy ke Mintlify

Langkah 1: Push ke GitHub

# Buat repository baru di GitHub
# Lalu push kode Anda:

git remote add origin https://github.com/USERNAME/csku-docs.git
git branch -M main
git push -u origin main

Langkah 2: Connect ke Mintlify

  1. Buka Mintlify Dashboard
  2. Klik "New Project" atau "Import Project"
  3. Pilih "Import from Git"
  4. Connect repository GitHub Anda
  5. Pilih repository csku-docs
  6. Mintlify akan otomatis deploy dokumentasi

Langkah 3: Akses Dokumentasi

Setelah deploy selesai, Anda akan mendapatkan URL seperti:

https://username.mintlify.app

Di dokumentasi yang sudah di-deploy:

  • ✅ Fitur interaktif API akan jalan
  • ✅ Bisa langsung test API dari browser
  • ✅ Komponen <ApiReference> akan menampilkan UI test API

Cara Test Lokal (Untuk Pengembangan)

Masalah

mintlify dev memerlukan Node.js LTS (v18, v20), bukan versi terbaru (v25).

Solusi

Sudah di-install Node 20 LTS:

# Pastikan menggunakan Node 20
node --version
# Harus: v20.x.x

# Jika masih v25, jalankan:
export PATH="/opt/homebrew/opt/node@20/bin:$PATH"

# Jalankan dev server
mintlify dev

Jika ingin test API tanpa Mintlify:

# Test langsung menggunakan curl
curl -X POST "http://localhost:8080/v1/message" \
  -H "Business: biz_123" \
  -H "Secret: secret123456" \
  -H "Content-Type: application/json" \
  -d '{
    "conversation_id": "conv_123",
    "text": "Test message"
  }'

Struktur Dokumentasi

csku-docs/
├── mint.json              # Konfigurasi Mintlify
├── openapi.yaml          # Spesifikasi OpenAPI (WAJIB untuk fitur API interaktif)
├── introduction.mdx        # Halaman intro
├── quickstart.mdx         # Quickstart
├── authentication.mdx     # Auth
├── error-codes.mdx       # Error codes
├── api-reference/         # Dokumentasi API
│   ├── introduction.mdx
│   ├── health/
│   ├── message/
│   ├── note/
│   └── conversation/
├── webhooks/             # Dokumentasi Webhook
│   ├── introduction.mdx
│   ├── authentication.mdx
│   ├── configuration.mdx
│   ├── best-practices.mdx
│   ├── retry-mechanism.mdx
│   ├── troubleshooting.mdx
│   ├── examples.mdx
│   └── events/           # Event types
└── logo/                 # Logo assets

File Penting

File Penting Deskripsi
openapi.yaml WAJIB Untuk fitur API interaktif di Mintlify
mint.json WAJIB Konfigurasi utama dokumentasi
*.mdx WAJIB Konten dokumentasi
Logo SVG Opsional Untuk branding

Masalah Umum

Fitur API tidak muncul di dev lokal

Penyebab: mintlify dev lokal kadang tidak menampilkan komponen OpenAPI secara penuh.

Solusi:

  • Deploy ke Mintlify cloud (rekomendasi)
  • Atau gunakan Mintlify terbaru dengan Node LTS

Build gagal karena versi Node salah

Solusi:

# Install Node 20 LTS
brew install node@20
brew link --overwrite node@20

# Verify
node --version

openapi.yaml validation error

Pastikan format benar:

openapi: 3.0.3
info:
  title: CSKU AI Public API
  version: "1.3"  # PAKAI TANDA KUTIP!

Deploy Alternatif

Jika tidak ingin deploy ke Mintlify:

Netlify

# Install Netlify CLI
npm install -g netlify-cli

# Deploy
netlify deploy --prod

Vercel

# Install Vercel CLI
npm install -g vercel

# Deploy
vercel

Support

Untuk bantuan lebih lanjut:

csku-docs

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published