Menambahkan atau Mengupdate Plugin

This guide explains how to add new Capacitor plugins to the Capgo website or update existing plugin documentation. This is useful for contributors, maintainers, and AI agents helping to maintain the documentation.

Ringkasan

Ketika menambahkan plugin baru ke ekosistem Capgo, Anda perlu memperbarui beberapa file dan lokasi di situs untuk memastikan plugin muncul dengan benar di semua tempat yang relevan:

1. Konfigurasi Daftar Plugin - Tambahkan metadata plugin ke daftar utama
2. Indeks Plugin - Tambahkan plugin ke halaman daftar plugin yang dikategorikan
3. Navigasi Samping - Tambahkan plugin ke sidebar dokumentasi
4. Dokumentasi Plugin - Buat halaman ringkasan dan mulai
5. Tutorial Plugin - Buat tutorial yang komprehensif

Lokasi File

File Utama untuk Diperbarui

File	Tujuan
/src/config/plugins.ts	Daftar plugin utama dengan metadata
/src/content/docs/docs/plugins/index.mdx	Halaman indeks plugin dengan kategori
/astro.config.mjs	Konfigurasi navigasi sampingan
/src/content/docs/docs/plugins/[plugin-name]/	Direktori dokumentasi plugin
/src/content/plugins-tutorials/en/	File tutorial bahasa Inggris

Petunjuk Langkah demi Langkah

1. Tambahkan Plugin ke Daftar Utama

   Buka /src/config/plugins.ts dan tambahkan plugin Anda ke actions array:

   // First, import an appropriate Heroicon
   import YourIconName from 'astro-heroicons/mini/IconName.astro'
   
   // Then add to the actions array
   {
     name: '@capgo/your-plugin-name',
     author: 'github.com/Cap-go',
     description: 'Brief description of what the plugin does',
     href: 'https://github.com/Cap-go/your-plugin-name/',
     title: 'Display Name',
     icon: YourIconName,
   }

   Ikon yang Tersedia: Periksa /node_modules/astro-heroicons/mini/ untuk ikon yang tersedia.

2. Tambahkan Plugin ke Halaman Index

   Buka /src/content/docs/docs/plugins/index.mdx dan tambahkan plugin Anda di bawah kategori yang tepat:

   <LinkCard
     title="Your Plugin Name"
     description="Brief description of what the plugin does"
     href="/docs/plugins/your-plugin-name/"
   />

   Kategori:

   • ⭐ Plugin Terkemuka
   • 📱 Plugin Perangkat & Sistem
   • 🎥 Plugin Media & Kamera
   • 🛠️ Plugin Utilitas
   • 🤖 AI & Media Maju
   • 📍 Lokasi & Layanan Latar
   • 📞 Komunikasi & Analitik
   • 🔐 Keamanan & Sistem
   • 📊 Fitur Android-Spesifik
   • 📥 Unduh & Navigasi

3. Tambahkan ke Navigasi Samping

   Buka /astro.config.mjs dan tambahkan plugin Anda ke konfigurasi sisi kiri (sekitar baris 540):

   {
     label: 'Your Plugin Name',
     items: [
       { label: 'Overview', link: '/docs/plugins/your-plugin-name/' },
       { label: 'Getting started', link: '/docs/plugins/your-plugin-name/getting-started' },
     ],
     collapsed: true,
   }

   Plugin-plugin tersebut terdaftar secara alfabetis di sisi kiri.

4. Buat Direktori Dokumentasi Plugin

   Buat direktori baru untuk dokumentasi plugin Anda:

   mkdir -p /src/content/docs/docs/plugins/your-plugin-name/

5. Buat Halaman Ringkasan Plugin

   Buat /src/content/docs/docs/plugins/your-plugin-name/index.mdx:

   ---
   title: "@capgo/your-plugin-name"
   description: Brief description of the plugin's purpose
   tableOfContents: false
   next: false
   prev: false
   sidebar:
     order: 1
     label: "Introduction"
   hero:
     tagline: Detailed tagline explaining what the plugin does
     image:
       file: ~public/your-plugin-icon.svg
     actions:
       - text: Get started
         link: /docs/plugins/your-plugin-name/getting-started/
         icon: right-arrow
         variant: primary
       - text: Github
         link: https://github.com/Cap-go/your-plugin-name/
         icon: external
         variant: minimal
   ---
   
   import { Card, CardGrid } from '@astrojs/starlight/components';
   
   <CardGrid stagger>
     <Card title="Feature 1" icon="puzzle">
       Description of first key feature
     </Card>
     <Card title="Feature 2" icon="rocket">
       Description of second key feature
     </Card>
     <Card title="Cross-platform" icon="puzzle">
       Works on both iOS and Android 📱
     </Card>
     <Card title="Comprehensive Documentation" icon="open-book">
       Check the [Documentation](/docs/plugins/your-plugin-name/getting-started/) to master the plugin.
     </Card>
   </CardGrid>

6. Buat Panduan Getting Started

   Buat /src/content/docs/docs/plugins/your-plugin-name/getting-started.mdx:

   ---
   title: Getting Started
   description: Learn how to install and use the plugin in your Capacitor app.
   sidebar:
     order: 2
   ---
   
   import { Steps } from '@astrojs/starlight/components';
   import { PackageManagers } from 'starlight-package-managers'
   
   <Steps>
   1. **Install the package**
      <PackageManagers pkg="@capgo/your-plugin-name" pkgManagers={['npm', 'pnpm', 'yarn', 'bun']} />
   
   2. **Sync with native projects**
      <PackageManagers type="exec" pkg="cap" args="sync" pkgManagers={['npm', 'pnpm', 'yarn', 'bun']} />
   </Steps>
   
   ## Configuration
   
   ### iOS Configuration
   [iOS-specific setup instructions]
   
   ### Android Configuration
   [Android-specific setup instructions]
   
   ## Usage
   
   [Basic usage examples]
   
   ## API Reference
   
   [Detailed API documentation]
   
   ## Complete Example
   
   [Full working example]
   
   ## Best Practices
   
   [Recommended practices and tips]
   
   ## Platform Notes
   
   [Platform-specific notes and limitations]

7. Buat File Tutorial

   Buat /src/content/plugins-tutorials/en/your-plugin-name.md:

   ---
   locale: en
   ---
   # Using @capgo/your-plugin-name Package
   
   The `@capgo/your-plugin-name` package [brief description]. In this tutorial, we will guide you through the installation, configuration, and usage of this package in your Ionic Capacitor app.
   
   ## Installation
   
   [Installation steps]
   
   ## Configuration
   
   [Configuration steps for iOS and Android]
   
   ## API Usage
   
   [Detailed API usage examples]
   
   ## Complete Example
   
   [Full working example]
   
   ## Best Practices
   
   [Tips and best practices]
   
   ## Troubleshooting
   
   [Common issues and solutions]
   
   ## Conclusion
   
   [Summary and links to additional resources]

Struktur Dokumentasi Plugin

File yang Diperlukan

src/content/docs/docs/plugins/your-plugin-name/
├── index.mdx           # Overview page with hero and feature cards
└── getting-started.mdx # Installation and usage guide

src/content/plugins-tutorials/en/
└── your-plugin-name.md # Comprehensive tutorial

File Opsional

Untuk plugin yang kompleks, Anda mungkin menambahkan halaman-halaman dokumentasi tambahan:

src/content/docs/docs/plugins/your-plugin-name/
├── index.mdx
├── getting-started.mdx
├── api-reference.mdx   # Detailed API documentation
├── examples.mdx        # Additional examples
├── troubleshooting.mdx # Troubleshooting guide
└── migrations.mdx      # Migration guides

Pedoman Konten

Menulis Deskripsi Plugin

• Jadilah Singkat: Simpan deskripsi di bawah 100 karakter
• Jelaslah: Jelaskan apa yang dilakukan plugin, bukan apa itu
• Gunakan Kata Kerja: Mulai dengan kata kerja seperti “Kontrol”, “Integrasikan”, “Aktifkan”

Contoh Baik:

• “Control device flashlight and torch with simple on/off toggle”
• “Integrate Crisp live chat and customer support into your app”
• “Enable secure authentication using Face ID and Touch ID”

Contoh Buruk:

• “A plugin for flash”
• “This is a Crisp plugin”
• “Biometric plugin”

Membuat Dokumentasi

1. Mulai dengan InstalasiSelalu mulai dengan langkah-langkah instalasi yang jelas
2. Berikan KonfigurasiTermasuk persyaratan pengaturan platform tertentu
3. Tunjukkan Contoh PenggunaanBerikan contoh code yang berfungsi
4. Termasuk API ReferensiDocument semua metode dan parameter
5. Tambahkan Contoh yang LengkapTunjukkan pola penggunaan nyata
6. Daftar Praktik Terbaik: Bagikan tips untuk penggunaan optimal
7. Dokumentasi Perbedaan Platform: Jelaskan perilaku iOS vs Android
8. Tambahkan Penyelesaian Masalah: Alami masalah umum

Code Contoh

• Gunakan TypeScript untuk semua code contoh
• Termasuk import di atas
• Tambahkan komentar menjelaskan langkah-langkah kunci
• Tampilkan penanganan kesalahan
• Demonstrasikan penggunaan dasar dan canggih

Daftar Periksa

Gunakan daftar periksa ini ketika menambahkan plugin baru:

• Menambahkan plugin ke /src/config/plugins.ts
• Memilih ikon yang tepat dari Heroicons
• Menambahkan plugin ke /src/content/docs/docs/plugins/index.mdx dibawah kategori yang benar
• Menambahkan entri sampingan di /astro.config.mjs
• Membuat direktori dokumentasi plugin
• Membuat index.mdx halaman ringkasan
• Dibuat getting-started.mdx panduan
• Membuat tutorial di /src/content/plugins-tutorials/en/
• Termasuk instruksi instalasi
• Mendokumentasikan konfigurasi iOS
• Mendokumentasikan konfigurasi Android
• Menggunakan contoh penggunaan
• Menambahkan API referensi
• Termasuk contoh kerja yang lengkap
• Mengulas praktik terbaik
• Menambahkan catatan spesifik platform
• Menguji semua tautan bekerja dengan benar

Referensi Icon

Ikon-ikon umum yang digunakan untuk plugin (dari astro-heroicons/mini/):

Icon	Penggunaan
BoltIcon	Ledakan, listrik, energi
CameraIcon	Kamera, foto, video
ChatBubbleLeftIcon	Chat, pesan, komunikasi
FingerPrintIcon	Biometrik, keamanan, autentikasi
MapPinIcon	Lokasi, lokasi geografis, peta
SpeakerWaveIcon	Audio, suara, musik
VideoCameraIcon	Video, rekaman, streaming
CreditCardIcon	Bayar, pembelian
PlayCircleIcon	Pemain media, pemutar video
SignalIcon	Koneksi, jaringan, beacon
RadioIcon	Beacon, siaran, nirkabel
ChatBubbleOvalLeftIcon	Sosial media, WeChat

Mengupdate Plugin yang Sudah Ada

Ketika mengupdate plugin yang sudah ada:

1. Perbarui nomor versi dalam dokumentasi
2. Tambahkan panduan migrasi jika perubahan yang mengganggu ada
3. Perbarui API referensi dengan metode baru
4. Tambahkan contoh baru untuk fitur baru
5. Perbarui persyaratan platform jika berubah
6. Revisi praktik terbaik berdasarkan fitur baru
7. Tetapkan tutorial saat ini dengan API terbaru

Jalur Bahasa

Tulis dan tinjau dokumen plugin dalam bahasa Inggris. Jalur lokal yang dihasilkan oleh metadata situs dan diterjemahkan di tepi oleh pekerja penerjemahan.

Menguji Perubahan

Setelah menambahkan atau memperbarui dokumentasi plugin:

1. Buat situs secara lokal:

   bun run build

2. Periksa kesalahan:

   • Pastikan semua tautan berfungsi
   • Pastikan gambar muat dengan benar
   • Konfirmasi contoh code yang valid
   • Uji navigasi berfungsi

3. Lihat pratinjau situs:

   bun run dev

4. Pastikan plugin Anda muncul:

   • Periksa halaman daftar plugin
   • Pastikan navigasi samping berfungsi
   • Uji semua halaman dokumentasi
   • Konfirmasi halaman tutorial berfungsi

Kesalahan Umum

Peringatan

Hindari kesalahan umum ini:

1. Lupa menyinkronkan: Selalu jalankan bunx cap sync dalam contoh
2. Penamaan tidak konsisten: Gunakan nama plugin yang sama di mana-mana
3. Konfigurasi platform hilang: Dokumentasikan setup iOS dan Android
4. Tautan rusak: Gunakan tautan relatif dan pastikan berfungsi
5. Tidak ada penanganan kesalahan: Selalu tunjukkan try-catch di contoh
6. Impor yang hilang: Pastikan Anda mencantumkan semua import yang diperlukan dalam contoh
7. Deskripsi yang tidak jelas: Berikan deskripsi yang spesifik tentang apa yang dilakukan plugin

Mendapatkan Bantuan

Jika Anda membutuhkan bantuan untuk menambahkan atau memperbarui dokumentasi plugin:

• Discord: Bergabunglah dengan komunitas Discord kami
• GitHub: Buatlah isu pada repository situs web
• Email: Hubungi tim di support@capgo.app

Contoh

Untuk referensi, cek plugin yang terdokumentasi dengan baik ini:

• Updater: /src/content/docs/docs/plugins/updater/ (plugin kompleks dengan beberapa halaman)
• Flash: /src/content/docs/docs/plugins/flash/ (plugin sederhana, contoh awal yang baik)
• Login Sosial: /src/content/docs/docs/plugins/social-login/ (plugin dengan sub-halaman)

Ringkasan

Menambahkan plugin ke dalam Capgo dokumentasi melibatkan:

1. Menambahkan metadata ke konfigurasi utama
2. Menambahkan plugin ke halaman indeks kategori
3. Mengonfigurasi navigasi sampingan
4. Membuat halaman dokumentasi yang komprehensif
5. Menulis tutorial yang rinci
6. Menguji semua perubahan secara lokal

Dengan mengikuti panduan ini, Anda memastikan bahwa plugin-nya terdokumentasi secara konsisten dan mudah ditemukan oleh pengguna.