Integrazione ReadMe
Pubblica guide per sviluppatori su ReadMe partendo da una registrazione dello schermo
Il tuo riferimento API spiega gli endpoint. Le tue guide spiegano tutto il resto. Registra un flusso una sola volta e Clevera scriverà la guida con screenshot, pubblicandola nel tuo hub per sviluppatori ReadMe, nella categoria che preferisci.
Guide nel tuo hub per sviluppatori
Callout e schede di codice ReadMe
Screenshot caricati su ReadMe
Aggiornamento tramite indirizzo
Cosa puoi fare
Le guide per la tua API,
scritte direttamente dal prodotto.
Gli sviluppatori arrivano nel tuo hub ReadMe per iniziare: creare un account, trovare la chiave API, configurare un webhook, testare nella dashboard. Queste pagine sono screenshot e clic, e diventano obsolete ogni volta che la dashboard cambia. Clevera le scrive partendo da una registrazione.
Per iniziare, clic dopo clic
Registra il percorso dall'iscrizione alla prima chiamata API nella tua dashboard. Clevera lo trasforma in una guida con passaggi numerati e uno screenshot per ciascuno.
Il codice resta codice
I blocchi di codice mantengono linguaggio e titolo. Le schede che contengono solo codice diventano schede di codice ReadMe, così un esempio cURL, Node e Python appaiono affiancati.
Archiviate dove gli sviluppatori navigano
Scegli una categoria di guida, come Getting Started o Webhooks, e la guida apparirà lì nella sezione Guide del tuo hub.
Screenshot ospitati da ReadMe
Gli screenshot vengono caricati su ReadMe, così la guida continua a funzionare anche se elimini l'articolo in Clevera.
Aggiorna le guide quando cambia la dashboard
Registra nuovamente il flusso, aggiorna l'articolo in Clevera e pubblica di nuovo. Clevera trova la guida tramite il suo indirizzo e la sovrascrive sul posto.
Sicuro con il formato pagina di ReadMe
Le parentesi graffe e angolari nel testo vengono convertite, così i segnaposto come {API_KEY} appaiono esattamente come scritti.
Come funziona
Dalla registrazione alla guida ReadMe
in quattro passaggi.
Incolla la chiave API del tuo progetto una volta. Dopodiché, qualsiasi articolo nell'area di lavoro può diventare una guida nel tuo hub.
- 1
Collega il tuo progetto
Copia una chiave API dalla configurazione del tuo progetto ReadMe, incollala in Clevera e lascia che verifichi la chiave. - 2
Clevera scrive la guida
Dalla tua registrazione dello schermo, Clevera scrive la guida: passaggi, screenshot, callout e codice. - 3
Scegli una categoria di guida
In Condividi, apri Pubblica, scegli la categoria della guida e clicca Pubblica su ReadMe. - 4
È nelle tue Guide
La guida appare sotto quella categoria nella versione principale del tuo progetto, a un indirizzo creato dal suo titolo.
Vedi in Clevera
Pubblicazione su ReadMe,
dalla finestra Condividi dell'articolo.
Niente copia-incolla nell'editor di ReadMe, niente caricamento di screenshot uno alla volta, niente riscrittura di callout nella sintassi di ReadMe. La finestra Condividi pubblica la guida per te.
Una chiave, un progetto
In ReadMe, apri Configurazione → Chiavi API e copia una chiave. Incollala in Clevera e clicca Verifica chiave; Clevera mostra il progetto a cui appartiene la chiave prima di salvare qualsiasi cosa.
La chiave fornisce accesso completo a quel progetto, quindi tienila privata. Per pubblicare su un progetto diverso, ricollegati con la chiave di quel progetto.
Scegli la categoria della guida
Progetto mostra l'hub collegato. Scegli una Categoria di guida: la guida va nella sezione Guide, sotto quella categoria. Non hai ancora categorie? Creane una prima su ReadMe.
L'indirizzo deriva dal titolo, quindi “Create your first API key” diventa /docs/create-your-first-api-key.
Compilato per te
Cosa finisce nel tuo hub per sviluppatori
e cosa decidi tu.
Clevera converte l'articolo nel formato pagina di ReadMe, così la guida usa i callout, i blocchi di codice e gli embed di ReadMe e può essere modificata in ReadMe come qualsiasi altra.
- Categoria di guidaScegli tu
- Qualsiasi categoria nelle Guide del tuo progetto. Clevera pubblica nella versione principale (stabile) della tua documentazione.
- Titolo e indirizzoImpostati per te
- Il titolo dell'articolo e un indirizzo creato da esso sotto
/docs/. Se quell'indirizzo è già in uso, ReadMe assegna alla nuova guida uno leggermente diverso. - VisibilitàDecidi tu
- Clevera non la imposta, quindi una nuova guida ottiene l'impostazione predefinita di ReadMe: pubblica. Modificala in ReadMe subito dopo la pubblicazione se vuoi prima revisionarla. Gli aggiornamenti mantengono la visibilità già assegnata alla guida.
- CalloutConvertiti per te
- Callout di ReadMe con il loro titolo: 📘 per info e note, 👍 per suggerimenti e successo, 🚧 per avvisi e ❗️ per pericoli.
- Codice e schedeConvertiti per te
- I blocchi di codice mantengono linguaggio e titolo. Le schede che contengono solo codice diventano schede di codice ReadMe; le altre schede diventano sezioni etichettate.
- Passaggi e toggleConvertiti per te
- I passaggi numerati diventano un elenco numerato con il titolo di ogni passaggio in grassetto. Le sezioni comprimibili diventano sezioni espandibili di ReadMe.
- Screenshot e videoImpostati per te
- Gli screenshot vengono caricati su ReadMe con le relative didascalie. I video inseriti nell'articolo diventano embed di ReadMe; un video Clevera deve avere il link di condivisione attivo.
Configurazione
Configura l'integrazione ReadMe
in circa due minuti.
Hai bisogno di un'area di lavoro Clevera con piano Pro o superiore e di un progetto ReadMe su ReadMe Refactored con almeno una categoria di guida. Il proprietario dell'area di lavoro o un amministratore collega ReadMe una volta; dopodiché, chiunque possa modificare un articolo può pubblicarlo. La pubblicazione non consuma crediti.
- 1
Copia una chiave API ReadMe
Nel tuo progetto ReadMe, apri Configurazione → Chiavi API e copia una chiave, o creane una se l'elenco è vuoto. - 2
Collega ReadMe in Clevera
Apri il menu dell'area di lavoro, scegli Integrazioni, trova ReadMe e clicca Collega. Incolla la chiave in Chiave API e clicca Verifica chiave. - 3
Conferma il progetto
Quando vedi “Chiave accettata.” e il tuo progetto sotto Siti su cui pubblicare, clicca Collega. - 4
Pubblica un articolo
Nell'editor dell'articolo, clicca Condividi, apri Pubblica, clicca sul riquadro ReadMe, scegli una Categoria di guida e clicca Pubblica su ReadMe. - 5
Aprilo in ReadMe
Quando vedi “Pubblicato su ReadMe.”, clicca Apri in ReadMe, e imposta la visibilità della guida se non dovrebbe essere ancora pubblica.
Domande sull'integrazione ReadMe
Funziona con i progetti su ReadMe Refactored, perché Clevera usa l'API attuale (v2) di ReadMe. I progetti ancora sulla vecchia piattaforma di ReadMe non possono essere collegati.
No. Clevera pubblica nella sezione Guide: le pagine di avvio, le guide pratiche e le pagine della dashboard attorno al tuo riferimento. Le tue pagine di riferimento API rimangono come sono.
La versione principale (stabile) delle Guide del tuo progetto.
Sì, per impostazione predefinita. Clevera non imposta una visibilità, quindi ReadMe usa la sua predefinita, che è pubblica. Nascondi la guida in ReadMe subito dopo la pubblicazione se vuoi prima revisionarla; gli aggiornamenti successivi mantengono tale visibilità.
Clevera cerca una guida con lo stesso indirizzo ovunque nelle tue Guide e mostra “Questo articolo è già su ReadMe.” Aggiornalo per sovrascrivere la guida allo stesso indirizzo, o crea una nuova guida con un nuovo titolo. Le modifiche apportate in ReadMe dall'ultima pubblicazione vengono sovrascritte da un aggiornamento.
No. La pubblicazione è unidirezionale, da Clevera a ReadMe. Una guida in ReadMe non cambia quando modifichi l'articolo in Clevera finché non pubblichi di nuovo, quindi mantieni l'articolo in Clevera come fonte per qualsiasi guida che mostri la tua dashboard.
Il proprietario dell'area di lavoro o un amministratore collega ReadMe una volta con la chiave del progetto. Dopodiché, chiunque possa modificare un articolo può pubblicarlo su ReadMe, senza mai vedere la chiave. Chi può solo visualizzare l'articolo non può pubblicarlo.
Sì, è una funzionalità separata e gratuita. Vedi l' importazione ReadMe e come Clevera si confronta con ReadMe. Questa integrazione è per i team che mantengono il loro hub per sviluppatori su ReadMe.
La pubblicazione su ReadMe fa parte dei piani Pro e Custom di Clevera e non consuma crediti; la creazione dell'articolo consuma crediti come al solito. Vedi prezzi.
La tua prossima guida introduttiva, già in ReadMe.
Registra il flusso una sola volta. Clevera scrive la guida e la pubblica nel tuo hub, screenshot inclusi.