Aperçu

Sources

Une source Docsbook est un dépôt ou un site web depuis lequel votre documentation est autorisée à lire. Connectez-en une, et demander à l’assistant de mettre à jour la documentation ou de résoudre la dérive commence par sa consultation — au lieu de répondre à partir de ce dont il se souvient de votre produit.

Ouvrez la section Sources du panneau d’administration de votre projet, directement sous MCP et Prompts.

Que puis-je connecter comme source ?#

Les sources Docsbook sont de cinq types — Votre projet, Plateformes de documentation, Bases de connaissances, Code et API et Communauté — et la plupart se connectent en collant une adresse. Un site de documentation publié est un site web, quel que soit son créateur. Mintlify, GitBook, ReadMe, Docusaurus, Read the Docs et les autres ne nécessitent donc aucune configuration spécifique au fournisseur.

Cette section est un tableau de tous les types de sources connus de Docsbook — Votre projet, Plateformes de documentation, Bases de connaissances, Code et API et Communauté — filtrés via un menu Filtres plutôt que répartis en sections regroupées. Chaque connexion possède sa propre ligne : deux sites web connectés correspondent à deux lignes, et non à une seule ligne qu’il faudrait ouvrir pour les voir. Un type auquel rien n’est connecté possède tout de même exactement une ligne grise. La plupart des types se connectent en un seul collage : un site de documentation publié est un site web, quel que soit son créateur. Mintlify, GitBook, ReadMe, Docusaurus, Read the Docs et les autres ne nécessitent donc aucune configuration spécifique au fournisseur.

Le gris peut avoir deux significations différentes, indiquées par la ligne :

  • Non connecté — la ligne propose une option Connecter. Sa consultation fonctionne dès aujourd’hui.
  • Pas encore disponible — la ligne ne propose aucun bouton et indique ce dont elle aurait besoin : une autorisation que vous accordez une seule fois, un jeton de bot ou un lecteur pour un hébergeur de dépôts que nous ne consultons pas encore. Lorsqu’une solution de contournement existe, la ligne l’indique : un centre d’aide public peut aujourd’hui être connecté comme site web.

Une ligne sans bouton est un choix délibéré. Un bouton Connecter qui ne permettrait pas de se connecter rendrait toutes les autres lignes à l’écran peu fiables.

Comment connecter une source ?#

Appuyez sur Connecter sur une ligne, ou sur le bouton Nouvelle source au-dessus du tableau pour n’importe quel élément. Dans les deux cas, il n’y a qu’un seul champ, et l’adresse détermine ce qu’est la source et sous quelle ligne elle apparaît — pas la ligne sur laquelle vous avez appuyé :

Ce que vous collez Ce que cela devient Ce qui est lu
github.com/acme/api Dépôt Ses fichiers, à la demande — README et documentation en premier
github.com/acme/api/tree/main/docs Dossier du dépôt Uniquement cette arborescence
acme.com ou acme.com/docs Site web Plusieurs de ses pages, trouvées à partir de son propre sitemap.xml
acme.com/pricing.html Page Cette page uniquement
acme.mintlify.app, acme.gitbook.io, acme.notion.site La ligne de ce fournisseur Comme pour un site web, classée à l’endroit où vous la chercheriez

Si l’adresse ne correspond pas à la ligne que vous avez ouverte, la boîte de dialogue vous le signale avant la validation.

Un lien collé depuis un ticket ou une pull request connecte le dépôt, pas le ticket. Les paramètres de suivi (?utm_source=…) sont supprimés, de sorte que la même page collée depuis un tweet et depuis votre barre d’adresse constitue une seule source plutôt que deux.

Un projet peut connecter plusieurs sources du même type — deux sites web, deux dépôts, deux forums. Utilisez également Nouvelle source pour la suivante : elle apparaît sur sa propre ligne, à côté de celle que vous avez déjà.

Deux entrées apparaissent sans que vous les ajoutiez, et aucune des deux ne peut être supprimée ici :

  • Dépôt de ce site — le dépôt à partir duquel votre documentation est générée.
  • Depuis la marque — l’URL de la source du site, si votre espace de travail en a défini une. Elle se trouve toujours sur la carte Marque.

Chaque source connectée peut contenir une courte note expliquant pourquoi elle est connectée. Cette note n’est pas décorative : l’assistant la lit comme une instruction.

En ligne, en pause, et ce que signifie le point vert#

Chaque source connectée affiche un point vert et le mot En ligne. Une source en pause affiche un point gris et la mention En pause.

Ce statut signifie que la source est connectée et que vos agents peuvent la lire. Il ne s’agit pas d’un contrôle d’état. Rien ne contacte l’hôte et rien ne vérifie que le dépôt existe toujours — un voyant d’état qu’aucun code ne met à jour est pire que l’absence totale de voyant. Le signal honnête est sa propre colonne Dernière utilisation, renseignée uniquement lorsqu’un outil a effectivement récupéré la source avec succès.

Chaque ligne contient son adresse sous forme de pastille et ses propres contrôles : Déconnecter conserve une source dans la liste et empêche toute lecture — appuyez à nouveau dessus (elle devient Connecter) pour reprendre. Supprimer retire définitivement la connexion de la liste. Ouvrir accède directement à l’adresse. Les deux façons d’arrêter la lecture d’une source sont différentes à dessein : « arrêter de la lire pour le moment » ne devrait pas vous obliger à saisir à nouveau l’adresse plus tard.

Qu’est-ce qui lit une source connectée ?#

Trois éléments lisent une source Docsbook : l’assistant de votre panneau d’administration, vos propres agents MCP et les exécutions en arrière-plan planifiées. Rien d’autre ne le fait — une source connectée n’est pas explorée périodiquement et ne devient pas partie intégrante de votre documentation publiée.

L’assistant de votre panneau d’administration. Ses deux outils, list_sources et read_source, sont disponibles à chaque tour plutôt que derrière une recherche, et ses instructions nomment littéralement vos sources connectées — une règle qui dit « consultez vos sources » sans les nommer est une règle qu’un modèle ne peut pas suivre.

Vos propres agents MCP. Les deux mêmes outils sont proposés via le point de terminaison MCP de votre projet, de sorte qu’une source que vous enregistrez signifie la même chose dans Claude Code ou Cursor qu’ici. Consultez la référence du serveur MCP.

Les exécutions en arrière-plan. Les invites planifiées et les exécutions d’agents les lisent aussi, et c’est là que cela compte le plus : personne n’est là pour coller un lien.

Une lecture de dépôt sans chemin répertorie ses fichiers lisibles ; avec un chemin, elle renvoie ce fichier. Une lecture de site web sans chemin renvoie plusieurs de ses pages au format Markdown, découvertes à partir du sitemap du site et limitées à la section que vous avez connectée — connectez acme.com/docs et le blog reste exclu. Les sites sans sitemap renvoient uniquement la page d’entrée, et le résultat le précise, de sorte qu’une lecture limitée n’est jamais confondue avec un site limité.

Quelles exécutions peuvent réellement lire une source ?#

Tous les outils n'accèdent pas à une source, c'est pourquoi le panneau indique lesquels le peuvent plutôt que de laisser entendre qu'ils en sont tous capables. Partout où une exécution est répertoriée — dans la colonne Sources du tableau des prompts et dans le bandeau situé sous la description d'un outil MCP — les pastilles apparaissent selon deux états :

  • Allumée — cette exécution récupère la source : les pages de votre site, les fichiers de votre dépôt.
  • Éteinte — cette exécution sait que la source est connectée, mais ne la récupérera pas. Demandez plutôt à l'assistant ; il n'a pas cette restriction.
  • Rien du tout — cette exécution n'accède à aucune source. Une écriture de paramètres n'a aucune raison de lire votre dépôt, et une pastille à cet endroit laisserait entendre le contraire.

Pourquoi connecter une source, au juste ?#

Parce qu’une source transforme « mettre à jour la documentation » d’une supposition en une lecture fiable. Les prix, les noms des forfaits, les limites, les points de terminaison, les numéros de version et le comportement évoluent tous plus vite que la documentation. Sans source, un assistant auquel on pose une question sur l’un de ces éléments répond soit qu’il ne sait pas, soit qu’il invente quelque chose de plausible — et cette invention plausible est la version qui parvient à vos lecteurs.

Avec une source connectée, cette question a une adresse. L’assistant lit votre page de tarification et corrige les trois pages qui citent encore l’ancien niveau ; il lit le dépôt et trouve les quatre choses que votre guide de démarrage rapide affirme, mais que le code a cessé de faire.

Que consomme la lecture d’une source ?#

list_sources lit les lignes que Docsbook stocke déjà et est facturé comme une lecture ordinaire. read_source quitte le réseau Docsbook pour récupérer votre dépôt ou votre site web — et une source de site web récupère plusieurs pages par appel — et est donc facturé comme un appel sortant. Les deux montants sont déduits du solde du projet concerné par l’appel. Les montants sont indiqués sur la page des tarifs de Docsbook.

Étapes suivantes#

Ouvrez Sources dans le panneau d’administration de votre projet et connectez le dépôt à partir duquel votre produit est créé — c’est la source qui répond au plus grand nombre de questions.

Updated

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