# Docs

> Ta documentation en MDX, avec un assistant IA qui cite ses sources.

Chaque page existe en Markdown à la même adresse suivie de `.md`. `llms-full.txt` contient toute la documentation en un seul fichier.

## Démarrer

- [Docs](https://docs.hgdc.ch/docs/index.md): Ta documentation en MDX, publiée avec Host, avec un assistant IA qui cite ses sources et un serveur MCP pour les agents.
- [Ta première doc en local](https://docs.hgdc.ch/docs/demarrer/premiere-doc.md): Créer le dossier, écrire docs.json et une première page, puis voir le site sur ton poste.
- [Mettre ta doc en ligne et activer l'assistant](https://docs.hgdc.ch/docs/demarrer/mettre-en-ligne.md): Publier le site avec Host, créer le projet dans la console Docs, puis poser une première question à l'assistant.

## Guides

- [Écrire une page](https://docs.hgdc.ch/docs/guides/ecrire-une-page.md): Titres, liens, images, code et métadonnées d'une page MDX, et ce qui n'est pas publié.
- [Écrire dans l'éditeur](https://docs.hgdc.ch/docs/guides/ecrire-dans-l-editeur.md): Modifier les pages et les réglages de ta doc depuis la console, sans Git, puis publier ou proposer une relecture.
- [Organiser la navigation](https://docs.hgdc.ch/docs/guides/navigation.md): Ranger les pages en groupes, en onglets et en versions dans docs.json.
- [Couleur, logo et favicon](https://docs.hgdc.ch/docs/guides/theme-et-logo.md): Régler la couleur, le logo et le favicon de ta doc dans docs.json.
- [Adresse du site et domaines](https://docs.hgdc.ch/docs/guides/adresses-du-site.md): Régler l'adresse publique de la doc et les autres adresses où l'assistant répond.
- [Publier ailleurs que sur Host](https://docs.hgdc.ch/docs/guides/hebergement-hors-host.md): Déposer le site construit chez un autre hébergeur, puis le relier à un projet de la console Docs.
- [Synchroniser et vérifier l'index](https://docs.hgdc.ch/docs/guides/synchroniser-et-verifier.md): Quand la console relit ton site, ce que fait chaque synchronisation, et comment vérifier que l'index est à jour.
- [Activer ou couper l'assistant](https://docs.hgdc.ch/docs/guides/activer-ou-couper-l-assistant.md): Quand l'assistant est visible sur le site, comment le couper sans republier, et comment le retirer du site.
- [Lire le journal et les questions sans réponse](https://docs.hgdc.ch/docs/guides/lire-le-journal.md): Lire les statistiques de l'assistant, filtrer le journal, et transformer les questions sans réponse en pages à écrire.
- [Connecter un agent au serveur MCP](https://docs.hgdc.ch/docs/guides/serveur-mcp.md): Ajouter le serveur MCP de ta doc à Claude Code, Cursor ou VS Code, pour que l'agent consulte ta documentation.
- [Supprimer un projet](https://docs.hgdc.ch/docs/guides/supprimer-un-projet.md): Supprimer un projet de la console Docs, ce qui disparaît, ce qui reste, et ce qu'il faut retirer du site.
- [Passer depuis Mintlify](https://docs.hgdc.ch/docs/guides/passer-depuis-mintlify.md): Reprendre une doc Mintlify dans Docs, ce qui se reprend tel quel, ce qui change, et ce qui n'est pas encore disponible.

## Référence

- [docs.json](https://docs.hgdc.ch/docs/reference/docs-json.md): Tous les champs du fichier de configuration d'un site Docs, leurs règles de validation et leurs messages d'erreur.
- [Composants MDX](https://docs.hgdc.ch/docs/reference/composants.md): Encadrés, étapes, onglets, cartes, accordéons et cadres disponibles dans chaque page, avec leurs attributs.
- [La commande hgdc-docs](https://docs.hgdc.ch/docs/reference/cli.md): Les commandes dev, build et preview, leurs options et les variables d'environnement du build.
- [Fichiers publiés](https://docs.hgdc.ch/docs/reference/fichiers-publies.md): Ce que le build écrit dans dist/, ce qui est publié et ce qui ne l'est pas, et les adresses que lisent les agents et la console.
- [API de l'assistant](https://docs.hgdc.ch/docs/reference/api-assistant.md): La requête que le widget envoie à l'assistant, la réponse, les règles de validation et les codes d'erreur.
- [Serveur MCP](https://docs.hgdc.ch/docs/reference/serveur-mcp.md): Transport, versions du protocole, méthodes, outils, codes d'erreur et limites du serveur MCP en lecture d'un projet.
- [Limites](https://docs.hgdc.ch/docs/reference/limites.md): Toutes les limites de Docs, par projet, par organisation, pour l'assistant et pour le serveur MCP, avec leurs valeurs exactes.
- [Erreurs de synchronisation](https://docs.hgdc.ch/docs/reference/erreurs-de-synchronisation.md): Chaque message d'échec de la console Docs lors de la lecture d'un site, sa cause et l'action à faire.

## Concepts

- [Comment ça marche](https://docs.hgdc.ch/docs/concepts/fonctionnement.md): Du push au site publié, puis à l'index de l'assistant, et à la réponse citée envoyée au visiteur.
- [L'assistant et ses sources](https://docs.hgdc.ch/docs/concepts/assistant-et-sources.md): D'où viennent les réponses de l'assistant, ce qu'il fait quand la doc ne répond pas, et comment lire ses statuts.
- [Organisations et rôles](https://docs.hgdc.ch/docs/concepts/organisations-et-roles.md): Comment les organisations et les membres arrivent dans la console Docs, et ce que peut faire chaque rôle.
- [Données et confidentialité](https://docs.hgdc.ch/docs/concepts/donnees-et-confidentialite.md): Quelles données Docs garde, pendant combien de temps, qui les traite, et comment les supprimer.
- [llms.txt, Markdown et serveur MCP](https://docs.hgdc.ch/docs/concepts/llms-txt-et-agents.md): Pourquoi et comment une doc Docs se lit par les outils d'IA, avec llms.txt, des pages en Markdown et un serveur MCP en lecture seule.