Saltar al contenido
Docs Flowy
Por qué sin configuración

El resto de herramientas de documentación
pide primero un archivo.

Antes de que cualquiera de ellas te muestre una sola página, escribes una lista de tus páginas. Esa lista es lo que se pudre, y se pudre en silencio, fusión tras fusión.
Conectar un repository
docs.json
{
  "navigation": { "groups": [{
    "group": "Get started",
    "pages": ["index", "quickstart"]
  }] }
}
Mintlify: cada página, en una lista.
mkdocs.yml
site_name: Acme
nav:
  - Inicio: index.md
  - Guías:
    - Instalación: guides/install.md
MkDocs: cada página, en una lista.
sidebars.js
module.exports = {
  docs: ['intro', {
    type: 'category',
    items: ['guides/install'],
  }],
};
Docusaurus: cada página, en una lista.
SUMMARY.md
# Summary

* [Introducción](README.md)
* [Guías](guides/README.md)
  * [Instalación](guides/install.md)
GitBook: cada página, en una lista.

Docs Flowy lee los mismos cuatro repositories y no necesita ninguno de estos archivos.

Busca en docs/, documentation/, doc/ y .github/docs/, después en las carpetas adr/, architecture/, specs/ y rfc/ de la raíz, y recurre a todos los archivos markdown que no estén en un directorio de dependencias. Los títulos salen del front matter, luego del primer encabezado y luego del nombre de archivo. El orden es README primero, luego los prefijos numéricos y después alfabético por título.

Existe un archivo de anulación. Nunca es obligatorio, y si un repository alguna vez lo necesita para leerse bien, es un fallo nuestro y no una tarea tuya.

Uno al lado del otro

Un sitio de documentación basado en configuración y Docs Flowy parten de lugares distintos

Cada fila de aquí es algo que la herramienta nombrada documenta sobre sí misma. Nada de esto juzga lo bien que hace el trabajo para el que fue creada.

Docs Flowysin configuración

Primeros pasos
Funciona sin archivo de configuración
Sí
La estructura de carpetas es la navegación
Sí
Orden de páginas mantenido a mano
No
Naturaleza de la herramienta
Hecho para
Primero tu equipo, después tus clientes
Muchos repositories, un solo espacio
Sí
Repositories privados, solo lectura
Sí
Necesita un paso de build
No
Lo que hace y un alojamiento de documentación no
Una superficie MCP para tus agentes
Sí
Estado de revisión e implementación
Sí
Notas que un agente responde y solo una persona cierra
Sí
Salud de la documentación: enlaces rotos, obsolescencia, documentación por detrás del código
Sí

Mintlifydocs.json

Primeros pasos
Funciona sin archivo de configuración
No
La estructura de carpetas es la navegación
No
Orden de páginas mantenido a mano
Sí
Naturaleza de la herramienta
Hecho para
Tus clientes
Muchos repositories, un solo espacio
No
Repositories privados, solo lectura
No
Necesita un paso de build
Sí
Lo que hace y un alojamiento de documentación no
Una superficie MCP para tus agentes
No
Estado de revisión e implementación
No
Notas que un agente responde y solo una persona cierra
No
Salud de la documentación: enlaces rotos, obsolescencia, documentación por detrás del código
No

MkDocsmkdocs.yml

Primeros pasos
Funciona sin archivo de configuración
No
La estructura de carpetas es la navegación
No
Orden de páginas mantenido a mano
Sí
Naturaleza de la herramienta
Hecho para
Tus clientes
Muchos repositories, un solo espacio
No
Repositories privados, solo lectura
No
Necesita un paso de build
Sí
Lo que hace y un alojamiento de documentación no
Una superficie MCP para tus agentes
No
Estado de revisión e implementación
No
Notas que un agente responde y solo una persona cierra
No
Salud de la documentación: enlaces rotos, obsolescencia, documentación por detrás del código
No

Docusaurussidebars.js

Primeros pasos
Funciona sin archivo de configuración
No
La estructura de carpetas es la navegación
No
Orden de páginas mantenido a mano
Sí
Naturaleza de la herramienta
Hecho para
Tus clientes
Muchos repositories, un solo espacio
No
Repositories privados, solo lectura
No
Necesita un paso de build
Sí
Lo que hace y un alojamiento de documentación no
Una superficie MCP para tus agentes
No
Estado de revisión e implementación
No
Notas que un agente responde y solo una persona cierra
No
Salud de la documentación: enlaces rotos, obsolescencia, documentación por detrás del código
No

GitBookSUMMARY.md

Primeros pasos
Funciona sin archivo de configuración
No
La estructura de carpetas es la navegación
No
Orden de páginas mantenido a mano
Sí
Naturaleza de la herramienta
Hecho para
Tus clientes
Muchos repositories, un solo espacio
No
Repositories privados, solo lectura
No
Necesita un paso de build
Sí
Lo que hace y un alojamiento de documentación no
Una superficie MCP para tus agentes
No
Estado de revisión e implementación
No
Notas que un agente responde y solo una persona cierra
No
Salud de la documentación: enlaces rotos, obsolescencia, documentación por detrás del código
No
Con honestidad

Cuándo deberías usar una de ellas

Son necesidades reales que este producto no cubre, ni cubrirá.

Un sitio diseñado desde cero
Componentes propios, un entorno interactivo para probar la API y un diseño a tu medida. Nuestro sitio público publica tu manual como versiones con nombre en la dirección docsflowy.site de tu equipo. No es un creador de sitios, y Mintlify hace bien ese trabajo.
Un relato ordenado a mano
Una serie de tutoriales en la que el capítulo tres debe seguir al dos por un motivo que ningún nombre de carpeta recoge. Nuestro orden se deduce, a propósito. Usa Docusaurus.
Una wiki para todo
Los documentos de tu repository siguen siendo de solo lectura aquí: los editas en tu editor y haces commit. Los borradores y las páginas del manual se escriben en Docs Flowy, pero si cada equipo necesita un lugar para escribir cualquier cosa, lo que buscas es una wiki.

Queda el caso para el que nadie construyó nada: documentación de ingeniería que ya existe, repartida en repositories, que cambia cada semana y que leen quienes la escribieron y los agentes que trabajan con ellos.

Apúntalo a un repository y mira lo que encuentra.

En menos de tres minutos sabrás si el árbol que construye es el que habrías escrito tú.

Empezar gratis