Docsbook
Aperçu

Concepts de Docsbook : espace de travail, équilibre du projet, indexation

Chaque terme utilisé dans l’interface et la documentation de Docsbook, défini une seule fois. Chaque entrée donne une définition en une phrase, puis indique où vous rencontrez le terme et ce qu’il affecte. Les termes sont regroupés, et les groupes sont classés par ordre alphabétique en leur sein.

Le site et son contenu#

Espace de travail#

Un espace de travail est un site de documentation et ses paramètres, reposant sur un dépôt de fichiers Markdown. Le dépôt se trouve soit sur votre propre compte GitHub, soit dans un dépôt que Docsbook héberge pour vous lorsque vous avez commencé à partir d’une analyse de site web ou d’un brief rédigé.

Un espace de travail possède son adresse, son apparence, ses paramètres de langue, ses statistiques et son solde. Le panneau d’administration et les écrans de facturation de Docsbook désignent le même objet par le terme projet ; ces deux mots désignent la même chose.

Brouillon#

Un brouillon est un site de documentation généré qui n’a pas encore été publié. Docsbook en crée un à partir de vos sources avant même que vous n’ayez un compte.

Un brouillon issu de l’analyse d’un site web ou d’un brief rédigé reste dans votre navigateur jusqu’à sa publication. Un brouillon s’ouvre dans le même panneau d’administration qu’un espace de travail publié, ce qui permet de définir la marque, la mise en page et le référencement avant de se connecter.

Page#

Une page est un fichier Markdown du dépôt de l’espace de travail, accessible via sa propre URL. Les noms des fichiers et des dossiers déterminent l’URL et la position dans l’arborescence de navigation.

Les extensions .md et .markdown sont prises en charge. Les fichiers dans d’autres formats — .txt, .rst — ne sont pas convertis en pages.

L’arborescence de navigation est la barre latérale que Docsbook génère à partir de la structure des dossiers de votre dépôt. Un dossier devient un groupe ; un fichier devient une entrée sous celui-ci.

README.md à la racine d’un dossier devient la page d’accueil de ce dossier. Vous n’avez pas besoin d’écrire de fichier de navigation : déplacer un fichier dans le dépôt le déplace également dans la barre latérale.

Plan#

Le plan est la table des matières de chaque page que Docsbook génère à partir des titres de cette page, affichée à droite du contenu. Cliquer sur un titre fait défiler la page jusqu'à celui-ci.

Le plan est généré à partir des titres H2 et des niveaux inférieurs. Ignorer un niveau de titre y laisse donc un espace.

Widget de contenu#

Un widget de contenu est une région d’une page Markdown que Docsbook affiche sous forme de bloc enrichi — une grille de cartes, un accordéon, des étapes numérotées ou un appel à l’action — signalée par deux commentaires HTML.

Les commentaires sont invisibles dans tous les autres lecteurs Markdown, de sorte que le même fichier reste correctement lisible sur GitHub. Un nom de widget inconnu est rétrogradé en Markdown ordinaire ; rien n’est jamais masqué. Consultez les widgets de contenu.

Comment le contenu est ajouté et reste à jour#

Indexation#

Indexation est le processus que Docsbook exécute sur votre Markdown pour créer tout ce dont le site a besoin : l’index de recherche, l’arborescence de navigation, le plan de chaque page, le graphe des liens et les représentations vectorielles utilisées par le chat IA pour récupérer des informations.

L’indexation s’exécute lors de la création d’un espace de travail, puis à nouveau lorsque Docsbook détecte du contenu modifié. Une page qui n’est pas indexée ne peut pas être trouvée par la recherche ni citée par le chat.

Synchronisation GitHub#

La synchronisation GitHub permet à un site Docsbook de rester à jour avec son dépôt : Docsbook vérifie la présence de nouveaux commits sur GitHub lorsque le site est consulté, puis réindexe les éléments modifiés. Aucun webhook n’est à configurer et aucune étape de compilation n’est à attendre.

Sont synchronisés : les nouveaux fichiers .md, les modifications de texte, les suppressions, les renommages et les nouveaux dossiers. Ne sont pas synchronisés : l’historique des commits, les informations sur les branches, les commentaires de code et les fichiers dans d’autres formats.

Source de vérité#

Une source de vérité est un dépôt ou un site web que vous avez connecté à un espace de travail afin qu’un agent qui rédige votre documentation y lise les faits au lieu de s’en souvenir. Chaque source connectée comporte la note de son propriétaire expliquant pourquoi elle est connectée.

Les sources sont des entrées en lecture seule. Elles sont distinctes du dépôt à partir duquel le site est construit. Voir Sources connectées.

Éditeur web#

L’éditeur web est l’éditeur intégré au navigateur de Docsbook pour les fichiers Markdown de l’espace de travail. L’enregistrement valide les modifications dans le dépôt à partir duquel le site est généré.

Les modifications effectuées dans l’éditeur web, sur GitHub et par un agent via MCP sont toutes enregistrées dans le même dépôt : il n’y a donc qu’un seul historique au lieu de deux.

Monnaie et comptage#

Solde du projet#

Le solde d’un projet est l’argent associé à un espace de travail, dépensé pour le travail effectué par l’IA dans cet espace. Chaque nouveau projet est créé avec un solde de 1,00 $, auquel s’ajoutent 5,00 $ que le propriétaire peut réclamer une fois que le projet a atteint 3 minutes d’existence. Il est ensuite approvisionné depuis l’écran de facturation.

Les soldes sont associés à chaque projet, et non à chaque compte : l’épuisement d’un projet n’arrête pas les autres. Consultez la page Tarifs.

Rechargement#

Un rechargement est un paiement vers le solde d’un projet, pour le montant de votre choix. Le plus petit rechargement unique est de $20.00 et le plus élevé est de $5,000.00.

Les rechargements n’expirent pas et aucun solde n’est réalimenté selon un calendrier. Un paiement mensuel récurrent peut être configuré sur l’écran de facturation ; il recharge le même solde chaque mois.

Travail facturé#

Le travail facturé correspond au travail qui utilise le solde d'un projet. Il en existe exactement quatre types, chacun correspondant à une ligne dans Dépenses par source sur la carte Limites du projet :

  • Lecteurs (chat IA) — une réponse d'IA fournie à un lecteur de la documentation publiée.
  • Admin & agent IA — l'exécution d'un agent, y compris les appels d'outils MCP facturés.
  • Traductions IA — la traduction d'une page dans une autre langue.
  • Index sémantique — la création des représentations vectorielles utilisées par le chat IA pour effectuer ses recherches.

Rien d'autre n'est facturé : l'hébergement, un domaine personnalisé et son certificat TLS, les lecteurs, les éditeurs, la synchronisation GitHub, la recherche en texte intégral, l'image de marque, les analyses et les appels de lecture MCP sont tous gratuits à l'utilisation. Chacune des quatre sources peut être plafonnée pour le cycle depuis la carte Limites, et un plafond de 0 $ désactive cette source.

Majoration#

La majoration est le pourcentage que Docsbook ajoute au prix réel facturé par le fournisseur d'IA pour le modèle qui a répondu — actuellement de 900 %. Le modèle, son tarif par million de tokens et la majoration sont tous affichés dans le tableau de bord.

L'utilisation de votre propre clé API de fournisseur la supprime : vous payez directement le fournisseur, et Docsbook ne vous facture rien pour cette utilisation.

Qui peut lire le site#

Site public#

Un site public est le comportement par défaut : toute personne disposant du lien peut le consulter, y compris les personnes sans compte GitHub et les robots des moteurs de recherche. La visibilité propre du dépôt ne change rien à cela — Docsbook lit le dépôt, puis diffuse les pages qu’il a générées.

Le caractère public permet au site d’être indexé par Google et cité par les assistants d’IA.

Site privé#

Un site privé affiche un écran de déverrouillage à la place de votre contenu pour tout le monde sauf le propriétaire, protégé par un mot de passe partagé ou par votre propre fournisseur d’identité SSO. La structure, les pages et l’index de recherche restent masqués jusqu’à ce qu’un lecteur le déverrouille.

Le propriétaire dispose toujours d’un accès complet, quelle que soit la visibilité. Consultez Documentation privée : mot de passe et SSO.

Domaine personnalisé#

Un domaine personnalisé est votre propre nom d’hôte — docs.yourcompany.com — qui diffuse l’espace de travail au lieu de docsbook.io/{owner}/{repo}. Vous ajoutez un enregistrement CNAME et Docsbook provisionne le certificat TLS.

L’adresse docsbook.io continue de fonctionner après l’association d’un domaine personnalisé. Consultez Configuration d’un domaine personnalisé.

Surfaces lues par les machines#

llms.txt#

llms.txt est un index en texte brut d’un site Docsbook, disponible à la racine du site pour les agents d’IA qui en recherchent un. Il répertorie les pages et le sujet couvert par chacune d’elles.

Docsbook le génère à partir du contenu indexé, afin qu’il ne devienne pas obsolète indépendamment du site. Voir llms.txt.

Serveur MCP#

Le serveur MCP est le point de terminaison du protocole Model Context Protocol de Docsbook à l’adresse https://docsbook.io/api/mcp/server, exposant 140 outils qui permettent à un agent IA de demander à l’agent docsbook_expert quoi faire et de recevoir des instructions en retour, de lire votre documentation, de la rechercher, de modifier les paramètres et de renvoyer des pages après validation. L’authentification utilise Bearer via OAuth 2.0 avec PKCE.

Les appels de découverte ne sont jamais décomptés ; les autres appels utilisent le solde du projet. Consultez le serveur MCP et la référence des outils MCP.

Widget flottant#

Le widget flottant est le menu de contrôle situé dans l’angle inférieur droit de votre propre documentation publiée, visible uniquement par vous lorsque vous êtes connecté. Les lecteurs ne le voient jamais.

Il permet de basculer entre le chat, le dépôt et le mode, d’ouvrir les paramètres et de vous déconnecter.

Updated

Cette page vous a-t-elle été utile ?