Integración con ReadMe
Publica guías para desarrolladores en ReadMe desde una grabación de pantalla
Tu referencia de API explica los endpoints. Tus guías explican todo lo que los rodea. Graba un flujo una vez y Clevera escribirá la guía con capturas de pantalla y la publicará en tu centro de desarrolladores de ReadMe, en la categoría de guía que elijas.
Guías en tu centro de desarrolladores
Callouts y pestañas de código de ReadMe
Capturas de pantalla subidas a ReadMe
Actualización por dirección
Lo que puedes hacer
Las guías sobre tu API,
escritas desde el propio producto.
Los desarrolladores llegan a tu centro de ReadMe para empezar: crear una cuenta, encontrar la clave de API, configurar un webhook, probar en el panel. Esas páginas son capturas de pantalla y clics, y quedan obsoletas cada vez que el panel cambia. Clevera las escribe a partir de una grabación.
Primeros pasos, mostrado clic a clic
Graba el camino desde el registro hasta la primera llamada a la API en tu panel. Clevera lo convierte en una guía con pasos numerados y una captura de pantalla para cada uno.
El código sigue siendo código
Los bloques de código mantienen su lenguaje y título. Las pestañas que solo contienen código se convierten en pestañas de código de ReadMe, por lo que una muestra en cURL, Node y Python aparecen una al lado de la otra.
Archivado donde los desarrolladores navegan
Elige una categoría de guía, como Primeros pasos o Webhooks, y la guía aparecerá allí en la sección Guías de tu centro.
Capturas de pantalla alojadas en ReadMe
Las capturas de pantalla se suben a ReadMe, por lo que la guía sigue funcionando incluso si eliminas el artículo en Clevera.
Actualiza las guías cuando el panel cambie
Vuelve a grabar el flujo, actualiza el artículo en Clevera y publica de nuevo. Clevera encuentra la guía por su dirección y la sobrescribe en el mismo lugar.
Seguro con el formato de página de ReadMe
Las llaves y los corchetes en tu texto se escapan, por lo que marcadores de posición como {API_KEY} se muestran exactamente como están escritos.
Cómo funciona
De la grabación a la guía de ReadMe
en cuatro pasos.
Pega la clave de API de tu proyecto una vez. Después de eso, cualquier artículo en el espacio de trabajo puede convertirse en una guía en tu centro.
- 1
Conecta tu proyecto
Copia una clave de API de la Configuración de tu proyecto de ReadMe, pégala en Clevera y deja que verifique la clave. - 2
Clevera escribe la guía
A partir de tu grabación de pantalla, Clevera escribe la guía: pasos, capturas de pantalla, callouts y código. - 3
Elige una categoría de guía
En Compartir, abre Publicar, elige la categoría de guía y haz clic en Publicar en ReadMe. - 4
Está en tus Guías
La guía aparece bajo esa categoría en la versión principal de tu proyecto, en una dirección creada a partir de su título.
Véalo en Clevera
Publicando en ReadMe,
desde la ventana Compartir del artículo.
Sin pegar en el editor de ReadMe, sin subir capturas de pantalla una por una, sin reescribir callouts en la sintaxis de ReadMe. La ventana Compartir publica la guía por ti.
Una clave, un proyecto
En ReadMe, abre la Configuración → Claves de API de tu proyecto y copia una clave. Pégala en Clevera y haz clic en Verificar clave; Clevera muestra el proyecto al que pertenece la clave antes de guardar nada.
La clave da acceso total a ese proyecto, así que mantenla privada. Para publicar en un proyecto diferente, vuelve a conectar con la clave de ese proyecto.
Elige la categoría de guía
Proyecto muestra el centro conectado. Elige una Categoría de guía: la guía va a la sección Guías, bajo esa categoría. ¿Aún no hay categorías? Crea una primero en ReadMe.
La dirección proviene del título, así que “Crea tu primera clave de API” se convierte en /docs/create-your-first-api-key.
Completado para ti
Lo que llega a tu centro de desarrolladores
y lo que tú decides.
Clevera convierte el artículo al formato de página propio de ReadMe, por lo que la guía utiliza los callouts, bloques de código e incrustaciones de ReadMe y puede editarse en ReadMe como cualquier otro.
- Categoría de guíaTú eliges
- Cualquier categoría en las Guías de tu proyecto. Clevera publica en la versión principal (estable) de tu documentación.
- Título y direcciónConfigurado para ti
- El título del artículo y una dirección creada a partir de él bajo
/docs/. Si esa dirección está ocupada, ReadMe le da a la nueva guía una ligeramente diferente. - VisibilidadTú decides
- Clevera no la establece, por lo que una nueva guía obtiene el valor predeterminado de ReadMe: público. Cámbialo en ReadMe justo después de publicar si quieres revisar primero. Las actualizaciones mantienen la visibilidad que ya tiene una guía.
- CalloutsConvertidos para ti
- Callouts de ReadMe con su título: 📘 para información y notas, 👍 para consejos y éxito, 🚧 para advertencias y ❗️ para peligro.
- Código y pestañasConvertidos para ti
- Los bloques de código mantienen su lenguaje y título. Las pestañas que solo contienen código se convierten en pestañas de código de ReadMe; otras pestañas se convierten en secciones etiquetadas.
- Pasos y togglesConvertidos para ti
- Los pasos numerados se convierten en una lista numerada con el título de cada paso en negrita. Las secciones plegables se convierten en secciones expandibles de ReadMe.
- Capturas de pantalla y vídeosConfigurado para ti
- Las capturas de pantalla se suben a ReadMe con sus pies de foto. Los vídeos colocados en el artículo se convierten en incrustaciones de ReadMe; un vídeo de Clevera necesita que su enlace para compartir esté activado.
Configuración
Configura la integración con ReadMe
en unos dos minutos.
Necesitas un espacio de trabajo de Clevera en Pro o superior, y un proyecto de ReadMe en ReadMe Refactored con al menos una categoría de guía. El propietario del espacio de trabajo o un Administrador conecta ReadMe una vez; después de eso, cualquiera que pueda editar un artículo puede publicarlo. Publicar no consume créditos.
- 1
Copia una clave de API de ReadMe
En tu proyecto de ReadMe, abre Configuración → Claves de API y copia una clave, o crea una si la lista está vacía. - 2
Conecta ReadMe en Clevera
Abre el menú del espacio de trabajo, elige Integraciones, busca ReadMe y haz clic en Conectar. Pega la clave en Clave de API y haz clic en Verificar clave. - 3
Confirma el proyecto
Cuando veas “Clave aceptada.” y tu proyecto bajo Sitios donde publicar, haz clic en Conectar. - 4
Publicar un artículo
En el editor de artículos, haz clic en Compartir, abre Publicar, haz clic en el mosaico de ReadMe, elige una Categoría de guía y haz clic en Publicar en ReadMe. - 5
Ábrelo en ReadMe
Cuando veas “Publicado en ReadMe.”, haz clic en Abrir en ReadMe, y establece la visibilidad de la guía si aún no debería ser pública.
Preguntas sobre la integración con ReadMe
Funciona con proyectos en ReadMe Refactored, porque Clevera utiliza la API actual (v2) de ReadMe. Los proyectos que aún están en la plataforma antigua de ReadMe no se pueden conectar.
No. Clevera publica en la sección Guías: las páginas de primeros pasos, tutoriales y panel alrededor de tu referencia. Tus páginas de referencia de API se quedan como están.
En la versión principal (estable) de las Guías de tu proyecto.
Sí, por defecto. Clevera no establece una visibilidad, por lo que ReadMe utiliza su valor predeterminado, que es público. Oculta la guía en ReadMe justo después de publicar si quieres revisarla primero; las actualizaciones posteriores mantienen esa visibilidad.
Clevera busca una guía con la misma dirección en cualquier lugar de tus Guías y muestra “Este artículo ya está en ReadMe.” Actualízalo para sobrescribir la guía en la misma dirección, o crea una nueva guía con un título nuevo. Los cambios realizados en ReadMe desde la última publicación se sobrescriben con una actualización.
No. La publicación es unidireccional, de Clevera a ReadMe. Una guía en ReadMe no cambia cuando editas el artículo en Clevera hasta que publicas de nuevo, así que mantén el artículo en Clevera como la fuente para cualquier guía que muestre tu panel.
El propietario del espacio de trabajo o un Administrador conecta ReadMe una vez con la clave del proyecto. Después de eso, cualquiera que pueda editar un artículo puede publicarlo en ReadMe, sin ver nunca la clave. Alguien que solo pueda ver el artículo no puede publicarlo.
Sí, esa es una función gratuita independiente. Consulta la importación de ReadMe y cómo se compara Clevera con ReadMe. Esta integración es para equipos que mantienen su centro de desarrolladores en ReadMe.
Publicar en ReadMe es parte de los planes Pro y Custom de Clevera y no consume créditos; crear el artículo consume créditos como de costumbre. Consulta los precios.
Tu próxima guía de inicio, ya en ReadMe.
Graba el flujo una vez. Clevera redacta la guía y la publica en tu centro de ayuda, con capturas de pantalla incluidas.