Aggiungere o Aggiornare Plugin

Questa guida spiega come aggiungere nuovi plugin Capacitor al sito Capgo o aggiornare la documentazione dei plugin esistenti. Ciò è utile per i contributori, i mantenitori e gli agenti IA che aiutano a mantenere la documentazione.

Panoramica

Quando si aggiunge un nuovo plugin all'ecosistema Capgo, è necessario aggiornare diversi file e posizioni sul sito per assicurarsi che il plugin apparisca correttamente in tutti i luoghi pertinenti:

1. Configurazione della lista dei plugin - Aggiungi i metadati del plugin alla lista principale
2. Pagina di indice dei plugin - Aggiungi il plugin alla pagina di elenco dei plugin categorizzati
3. Navigazione laterale - Aggiungi plugin al menu della documentazione
4. Documentazione del Plugin - Crea pagine di panoramica e avvio
5. Tutorial del Plugin - Crea un tutorial esaustivo

Posizioni dei file

File chiave da aggiornare

File	Scopo
/src/config/plugins.ts	Elenco dei plugin principali con metadati
/src/content/docs/docs/plugins/index.mdx	Pagina di indice dei plugin con categorie
/astro.config.mjs	Configurazione della navigazione del lato
/src/content/docs/docs/plugins/[plugin-name]/	Directory dei documenti del plugin
/src/content/plugins-tutorials/en/	File di tutorial in inglese

Guida Passo-dopo-Passo

1. Aggiungi Plugin alla Lista Principale

   Apri /src/config/plugins.ts e aggiungi il tuo plugin all' 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,
   }

   Icone Disponibili: Controlla /node_modules/astro-heroicons/mini/ per le icone disponibili.

2. Aggiungi Plugin alla Pagina di Indice

   Apri /src/content/docs/docs/plugins/index.mdx e aggiungi il tuo plugin nella categoria appropriata:

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

   Categorie:

   • ⭐ Plugin in evidenza
   • 📱 Plugin per dispositivi e sistema
   • 🎥 Plugin per media e fotocamera
   • 🛠️ Plugin di Utilità
   • 🤖 AI e Media Avanzati
   • 📍 Posizione e Servizi di Background
   • 📞 Comunicazione e Analisi
   • 🔐 Sicurezza e Sistema
   • 📊 Caratteristiche Specifiche per Android
   • 📥 Download e Navigazione

3. Aggiungi alla Navigazione del Lato

   Apre /astro.config.mjs e aggiungi il tuo plugin alla configurazione della navigazione del lato (circa linea 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,
   }

   Aggiornamenti dei plugin sono elencati in ordine alfabetico nella barra laterale.

4. Crea cartella di documentazione del plugin

   Crea una nuova cartella per la documentazione del tuo plugin:

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

5. Crea pagina di panoramica del plugin

   Crea /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. Crea guida per l'avvio

   Crea /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. Crea File di Tutorial

   Crea /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]

Struttura della Documentazione del Plugin

File Richiesti

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 Facoltativi

Per plugin complessi, potresti aggiungere pagine di documentazione aggiuntive:

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

Linee guida del contenuto

Scrivere descrizioni dei plugin

• Sii conciso: Mantieni le descrizioni sotto i 100 caratteri
• Sii specifico: Spiega cosa fa il plugin, non cosa è
• Usa verbi d'azione: Inizia con verbi come “Controlla”, “Integra”, “Abilita”

Esempi di Buona Qualità:

• “Controlla il flash della fotocamera e la torcia con un semplice interruttore on/off”
• “Integra il servizio di chat live Crisp e il supporto al cliente nel tuo app”
• “Abilita l’autenticazione sicura utilizzando Face ID e Touch ID”

Esempi di Cattiva Qualità:

• “Un plugin per il flash”
• “Questo è un plugin per Crisp”
• “Plugin di rilevamento biometrico”

Scrivere la Documentazione

1. Inizia con l'Installazione: Inizia sempre con passaggi di installazione chiari
2. Fornisci Configurazione: Includi requisiti di configurazione specifici per piattaforma
3. Mostra Esempi di Utilizzo: Fornisci esempi di lavoro code
4. Includi API Riferimento: Documenta tutti i metodi e i parametri
5. Aggiungi Esempi Completi: Mostra modelli di utilizzo realistici
6. Elenco le Migliori Pratiche: Condividi consigli per un utilizzo ottimale
7. Documenta le Differenze di Piattaforma: Spiegare il comportamento iOS vs Android
8. Aggiungi la sezione di risoluzione dei problemi: Risolvi i problemi comuni

Esempi Code

• Usa TypeScript per tutti gli esempi code
• Includi le importazioni in alto
• Aggiungi commenti che spiegano i passaggi chiave
• Mostra il gestione degli errori
• Dimostra sia l'utilizzo base che avanzato

Elenco di controllo

Usa questa checklist quando si aggiunge un nuovo plugin:

• Aggiunto plugin a /src/config/plugins.ts
• Selezionato icona appropriata da Heroicons
• Aggiunto plugin a /src/content/docs/docs/plugins/index.mdx sotto categoria corretta
• Aggiunto voce di navigazione in /astro.config.mjs
• Creati directory di documentazione del plugin
• Creato index.mdx pagina di panoramica
• Creato getting-started.mdx guida
• Creato tutorial in /src/content/plugins-tutorials/en/
• Istruzioni di installazione incluse
• Documentazione della configurazione iOS
• Documentazione della configurazione Android
• Esempi di utilizzo inclusi
• Aggiunta di riferimento a API
• Esempio completo e funzionante incluso
• Elencate le migliori pratiche
• Aggiunte note specifiche per piattaforma
• Verificati tutti i collegamenti per garantire il loro funzionamento corretto

Riferimento alle icone

Icone comuni utilizzate per i plugin (da astro-heroicons/mini/):

Icone	Utilizzo
BoltIcon	Flash, potenza, energia
CameraIcon	Camera, foto, video
ChatBubbleLeftIcon	Chat, messaggistica, comunicazione
FingerPrintIcon	Biometrica, sicurezza, autenticazione
MapPinIcon	Posizione, geolocalizzazione, mappe
SpeakerWaveIcon	Audio, suono, musica
VideoCameraIcon	Video, registrazione, streaming
CreditCardIcon	Pagamenti, acquisti
PlayCircleIcon	Lettori multimediali, lettori video
SignalIcon	Connettività, rete, beacon
RadioIcon	Beacon, broadcast, wireless
ChatBubbleOvalLeftIcon	Social media, WeChat

Aggiornamento dei Plugin Esistenti

Quando si aggiorna un plugin esistente:

1. Aggiorna i numeri di versione nelle documentazioni
2. Aggiungi guide di migrazione se esistono cambiamenti dirompenti
3. Aggiorna la API reference con nuove metodi
4. Aggiungi nuovi esempi per nuove funzionalità
5. Aggiorna le richieste del platform se cambiate
6. Rivedere le migliori pratiche basate su nuove funzionalità
7. Mantieni il tutorial aggiornato con il più recente API

Percorsi di Lingua

Scrivi e revisiona i documenti del plugin in inglese. I percorsi localizzati sono generati dai metadati del sito e tradotti all'edge dal Worker di traduzione.

Testare le tue modifiche

Dopo aver aggiunto o aggiornato la documentazione del plugin:

1. Costruisci il sito localmente:

   bun run build

2. Controlla gli errori:

   • Verifica che tutti i collegamenti funzionino
   • Assicurati che le immagini si caricano correttamente
   • Conferma che gli esempi code sono validi
   • Testa la navigazione

3. Anteprima il sito:

   bun run dev

4. Verifica che il tuo plugin sia presente:

   • Controlla la pagina di elenco plugin
   • Verifica la navigazione laterale
   • Testa tutte le pagine di documentazione
   • Verifica che la pagina del tutorial funzioni

Pitfall comune

Attenzione

Evita questi errori comuni:

1. Dimenticare di sincronizzare : sempre esegui bunx cap sync in esempi
2. Nomi non coerenti: Utilizza lo stesso nome del plugin in ogni luogo
3. Configurazione della piattaforma mancante: Documenta sia la configurazione iOS che Android
4. Collegamenti rotti: Utilizza collegamenti relativi e verifica che funzionino
5. Assenza di gestione degli errori: Mostra sempre try-catch negli esempi
6. Importazioni mancanti: Includi tutte le importazioni necessarie negli esempi
7. Descrizioni poco chiare: Sii specifico su cosa fa il plugin

Aiuto

Se hai bisogno di aiuto per aggiungere o aggiornare la documentazione del plugin:

• Discord: Unisciti alla nostra community di Discord
• GitHub: Apri un issue nel repository del sito web
• Email: Contattaci nel team support@capgo.app

Esempi

Per riferimento, controlla questi plugin ben documentati:

• Aggiornatore: /src/content/docs/docs/plugins/updater/ (plugin complesso con più pagine)
• Flash: /src/content/docs/docs/plugins/flash/ (plugin semplice, buon esempio di partenza)
• Login Social: /src/content/docs/docs/plugins/social-login/ (plugin con sottopagine)

Riepilogo

Aggiungere un plugin alla Capgo documentazione comporta:

1. Aggiungere metadati alla configurazione principale
2. Aggiungere il plugin alla pagina di indice categorizzata
3. Configurare la navigazione del lato laterale
4. Creare pagine di documentazione esaustive
5. Scrivere un tutorial dettagliato
6. Testare tutte le modifiche localmente

Seguendo questa guida, si assicura che i plugin siano documentati in modo coerente e facilmente scopribili dagli utenti.

Continua da Aggiungere o Aggiornare Plugin

Se stai utilizzando Aggiungere o Aggiornare Plugin per pianificare il lavoro di plugin nativo, connettilo con Capgo Directory dei Plugin per il flusso di lavoro del prodotto in Capgo Directory dei Plugin, Capacitor Plugin da Capgo per i dettagli di implementazione in Capacitor Plugin da Capgo, Alternative per Plugin Enterprise di Ionic per il flusso di lavoro del prodotto in Alternative per Plugin Enterprise di Ionic, Capgo Costruzioni Native per il flusso di lavoro del prodotto in Capgo Costruzioni Native, e Capacitor Plugin: Cosa Devi Sapere per il contesto pratico in Capacitor Plugin: Cosa Devi Sapere.