Aller au contenu
Docs Flowy
Pourquoi sans configuration

Tous les autres outils de documentation
demandent d'abord un fichier.

Avant que l’un d’eux ne vous montre une seule page, vous écrivez la liste de vos pages. C’est cette liste qui pourrit — et elle pourrit sans bruit, une fusion après l’autre.
Connecter un repository
docs.json
{
  "navigation": { "groups": [{
    "group": "Get started",
    "pages": ["index", "quickstart"]
  }] }
}
Mintlify — chaque page, listée.
mkdocs.yml
site_name: Acme
nav:
  - Accueil: index.md
  - Guides:
    - Installation: guides/install.md
MkDocs — chaque page, listée.
sidebars.js
module.exports = {
  docs: ['intro', {
    type: 'category',
    items: ['guides/install'],
  }],
};
Docusaurus — chaque page, listée.
SUMMARY.md
# Summary

* [Introduction](README.md)
* [Guides](guides/README.md)
  * [Installation](guides/install.md)
GitBook — chaque page, listée.

Docs Flowy lit les quatre mêmes repositories et n’a besoin d’aucun de ces fichiers.

Il regarde dans docs/, documentation/, doc/ et .github/docs/, puis dans les dossiers adr/, architecture/, specs/ et rfc/ à la racine, et se rabat sur tous les fichiers markdown qui ne sont pas dans un répertoire de dépendances. Les titres viennent du front matter, puis du premier titre, puis du nom de fichier. L’ordre : README d’abord, puis les préfixes numériques, puis l’ordre alphabétique des titres.

Il existe un fichier de surcharge. Il n’est jamais requis, et si un repository en a un jour besoin pour être bien lu, c’est notre bug et pas votre travail.

Côte à côte

Un site de documentation piloté par configuration et Docs Flowy ne partent pas du même endroit

Chaque ligne ici est une chose que l'outil nommé documente à son propre sujet. Rien de tout cela ne juge sa qualité pour le travail pour lequel il a été conçu.

Docs Flowysans configuration

Démarrage
Fonctionne sans fichier de configuration
Oui
L'arborescence est la navigation
Oui
Ordre des pages maintenu à la main
Non
Nature de l'outil
Conçu pour
Votre équipe d’abord, puis vos clients
Plusieurs repositories, un seul espace
Oui
Repositories privés, en lecture seule
Oui
Nécessite une étape de build
Non
Ce qu'il fait et qu'un hébergeur de documentation ne fait pas
Une surface MCP pour vos agents
Oui
Statut de relecture et d'implémentation
Oui
Des notes auxquelles un agent répond et que seule une personne ferme
Oui
Santé de la documentation — liens cassés, obsolescence, documentation en retard sur le code
Oui

Mintlifydocs.json

Démarrage
Fonctionne sans fichier de configuration
Non
L'arborescence est la navigation
Non
Ordre des pages maintenu à la main
Oui
Nature de l'outil
Conçu pour
Vos clients
Plusieurs repositories, un seul espace
Non
Repositories privés, en lecture seule
Non
Nécessite une étape de build
Oui
Ce qu'il fait et qu'un hébergeur de documentation ne fait pas
Une surface MCP pour vos agents
Non
Statut de relecture et d'implémentation
Non
Des notes auxquelles un agent répond et que seule une personne ferme
Non
Santé de la documentation — liens cassés, obsolescence, documentation en retard sur le code
Non

MkDocsmkdocs.yml

Démarrage
Fonctionne sans fichier de configuration
Non
L'arborescence est la navigation
Non
Ordre des pages maintenu à la main
Oui
Nature de l'outil
Conçu pour
Vos clients
Plusieurs repositories, un seul espace
Non
Repositories privés, en lecture seule
Non
Nécessite une étape de build
Oui
Ce qu'il fait et qu'un hébergeur de documentation ne fait pas
Une surface MCP pour vos agents
Non
Statut de relecture et d'implémentation
Non
Des notes auxquelles un agent répond et que seule une personne ferme
Non
Santé de la documentation — liens cassés, obsolescence, documentation en retard sur le code
Non

Docusaurussidebars.js

Démarrage
Fonctionne sans fichier de configuration
Non
L'arborescence est la navigation
Non
Ordre des pages maintenu à la main
Oui
Nature de l'outil
Conçu pour
Vos clients
Plusieurs repositories, un seul espace
Non
Repositories privés, en lecture seule
Non
Nécessite une étape de build
Oui
Ce qu'il fait et qu'un hébergeur de documentation ne fait pas
Une surface MCP pour vos agents
Non
Statut de relecture et d'implémentation
Non
Des notes auxquelles un agent répond et que seule une personne ferme
Non
Santé de la documentation — liens cassés, obsolescence, documentation en retard sur le code
Non

GitBookSUMMARY.md

Démarrage
Fonctionne sans fichier de configuration
Non
L'arborescence est la navigation
Non
Ordre des pages maintenu à la main
Oui
Nature de l'outil
Conçu pour
Vos clients
Plusieurs repositories, un seul espace
Non
Repositories privés, en lecture seule
Non
Nécessite une étape de build
Oui
Ce qu'il fait et qu'un hébergeur de documentation ne fait pas
Une surface MCP pour vos agents
Non
Statut de relecture et d'implémentation
Non
Des notes auxquelles un agent répond et que seule une personne ferme
Non
Santé de la documentation — liens cassés, obsolescence, documentation en retard sur le code
Non
Honnêtement

Quand leur préférer l'un d'eux

Ce sont de vrais besoins que ce produit ne couvre pas, et ne couvrira pas.

Un site conçu de toutes pièces
Des composants sur mesure, un bac à sable d’API interactif et un design bien à vous. Notre site public publie votre manuel sous forme de versions nommées à l’adresse docsflowy.site de votre équipe. Ce n’est pas un constructeur de sites, et Mintlify fait bien ce travail.
Un récit ordonné à la main
Une série de tutoriels où le chapitre trois doit suivre le chapitre deux pour une raison qu’aucun nom de dossier ne traduit. Notre ordre est déduit, à dessein. Utilisez Docusaurus.
Un wiki pour tout
Les documents de votre repository restent en lecture seule ici : vous les modifiez dans votre éditeur et faites un commit. Les brouillons et les pages du manuel s’écrivent dans Docs Flowy, mais si chaque équipe a besoin d’un endroit pour écrire n’importe quoi, c’est un wiki qu’il vous faut.

Reste le cas pour lequel personne n’a rien construit : une documentation d’ingénierie qui existe déjà, répartie sur des repositories, qui change chaque semaine, lue par les personnes qui l’ont écrite et par les agents qui travaillent à leurs côtés.

Pointez-le vers un repository et voyez ce qu’il trouve.

En moins de trois minutes, vous saurez si l’arborescence qu’il construit est celle que vous auriez écrite.

Commencer gratuitement