@hgdc/docs 0.1.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs.schema.json +25 -0
- package/package.json +3 -1
- package/src/build/auto-import.ts +5 -24
- package/src/build/base-links.ts +35 -0
- package/src/build/outputs.ts +17 -4
- package/src/core/components.ts +166 -0
- package/src/core/config.ts +50 -0
- package/src/core/feedback-api.ts +17 -0
- package/src/core/llms.ts +8 -5
- package/src/core/navigation.ts +24 -0
- package/src/core/validate.ts +276 -0
- package/src/integration.ts +71 -21
- package/src/overrides/Footer.astro +154 -0
- package/src/overrides/Head.astro +4 -2
- package/src/overrides/PageTitle.astro +3 -2
- package/src/overrides/Sidebar.astro +2 -2
- package/src/overrides/SocialIcons.astro +59 -0
- package/template/.astro/content-assets.mjs +4 -1
- package/template/.build/.well-known/llms.txt +5 -5
- package/template/.build/404.html +5 -5
- package/template/.build/_astro/{common.8GHCkW7i.css → common.CQYUsl_5.css} +2 -2
- package/template/.build/_hgdc/corpus.json +1 -1
- package/template/.build/demarrer/premiere-doc/index.html +12 -12
- package/template/.build/demarrer/premiere-doc.md +1 -1
- package/template/.build/explications/donnees/index.html +11 -11
- package/template/.build/explications/donnees.md +1 -1
- package/template/.build/explications/fonctionnement/index.html +12 -12
- package/template/.build/explications/fonctionnement.md +3 -3
- package/template/.build/guides/agents/index.html +15 -10
- package/template/.build/guides/agents.md +15 -1
- package/template/.build/guides/assistant/index.html +14 -12
- package/template/.build/guides/assistant.md +5 -1
- package/template/.build/guides/composants/index.html +15 -15
- package/template/.build/guides/ecrire/index.html +12 -12
- package/template/.build/guides/ecrire.md +1 -1
- package/template/.build/guides/elements/index.html +1 -0
- package/template/.build/guides/navigation/index.html +11 -11
- package/template/.build/guides/publier/index.html +16 -16
- package/template/.build/guides/publier.md +8 -8
- package/template/.build/guides/theme/index.html +11 -11
- package/template/.build/guides/theme.md +1 -1
- package/template/.build/index.html +11 -11
- package/template/.build/index.md +5 -5
- package/template/.build/llms-full.txt +69 -47
- package/template/.build/llms.txt +5 -5
- package/template/.build/pagefind/fragment/fr-ch_2a431a9.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_35f556a.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_456586a.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_48ca71e.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_72b91f4.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_8f256dd.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_95a15cc.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_aa80c55.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_ab79738.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_c589c2a.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_dab8f5e.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_de60b43.pf_fragment +0 -0
- package/template/.build/pagefind/index/fr-ch_c5ced52.pf_index +0 -0
- package/template/.build/pagefind/pagefind-entry.json +1 -1
- package/template/.build/pagefind/pagefind.fr-ch_8a246aa922758.pf_meta +0 -0
- package/template/.build/reference/api-assistant/index.html +11 -11
- package/template/.build/reference/api-assistant.md +3 -3
- package/template/.build/reference/cli/index.html +11 -11
- package/template/.build/reference/cli.md +5 -5
- package/template/.build/reference/docs-json/index.html +35 -11
- package/template/.build/reference/docs-json.md +19 -15
- package/template/.build/reference/mcp/index.html +10 -10
- package/template/node_modules/.vite/deps/_metadata.json +8 -8
- package/template/.build/pagefind/fragment/fr-ch_424fd16.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_5a4d77d.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_6c36edc.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_73d7887.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_8234ed3.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_8f8a19e.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_9f1b981.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_a19039d.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_d72cc1e.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_d732215.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_e78d58b.pf_fragment +0 -0
- package/template/.build/pagefind/fragment/fr-ch_e92f972.pf_fragment +0 -0
- package/template/.build/pagefind/index/fr-ch_f94c95d.pf_index +0 -0
- package/template/.build/pagefind/pagefind.fr-ch_fb78ab42961f4.pf_meta +0 -0
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Docs
|
|
2
2
|
|
|
3
|
-
> Écrire une documentation en MDX, la publier avec
|
|
3
|
+
> Écrire une documentation en MDX, la publier avec Host et y brancher un assistant IA qui cite ses sources.
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
7
|
Source : /
|
|
8
8
|
|
|
9
|
-
# Bienvenue dans
|
|
9
|
+
# Bienvenue dans Docs
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Docs transforme un dossier de pages MDX en site de documentation. Tu écris dans ton dépôt Git, Host publie le site à chaque push, et la console `docs.hgdc.ch` branche un assistant qui répond à tes visiteurs à partir de ta doc, et de rien d’autre.
|
|
12
12
|
|
|
13
13
|
[Ta première doc](/demarrer/premiere-doc/)
|
|
14
14
|
|
|
15
15
|
[Un dossier, un fichier `docs.json` et une page : ton site tourne en local en cinq minutes.](/demarrer/premiere-doc/)
|
|
16
16
|
|
|
17
|
-
[Publier avec
|
|
17
|
+
[Publier avec Host](/guides/publier/)
|
|
18
18
|
|
|
19
|
-
[Relie le dépôt à
|
|
19
|
+
[Relie le dépôt à Host : chaque push met le site à jour.](/guides/publier/)
|
|
20
20
|
|
|
21
21
|
[L'assistant IA](/guides/assistant/)
|
|
22
22
|
|
|
@@ -40,7 +40,7 @@ Le fichier `docs.json` reprend celui de Mintlify : nom, couleurs, logo, navigati
|
|
|
40
40
|
|
|
41
41
|
> **Tout reste en Suisse quand c'est possible**
|
|
42
42
|
>
|
|
43
|
-
> Le site est servi par
|
|
43
|
+
> Le site est servi par Host. Les questions des visiteurs sont gardées 90 jours au plus. Voir [Données et confidentialité](/explications/donnees/).
|
|
44
44
|
|
|
45
45
|
---
|
|
46
46
|
|
|
@@ -108,7 +108,7 @@ Il te faut Node.js 22 ou plus récent, ou Bun. Tout le reste s’installe avec l
|
|
|
108
108
|
|
|
109
109
|
## Et ensuite
|
|
110
110
|
|
|
111
|
-
- [Publier avec
|
|
111
|
+
- [Publier avec Host](/guides/publier/) pour mettre le site en ligne.
|
|
112
112
|
- [Écrire en MDX](/guides/ecrire/) pour les titres, les liens, les images et le code.
|
|
113
113
|
- [docs.json](/reference/docs-json/) pour toutes les options.
|
|
114
114
|
|
|
@@ -116,15 +116,15 @@ Il te faut Node.js 22 ou plus récent, ou Bun. Tout le reste s’installe avec l
|
|
|
116
116
|
|
|
117
117
|
Source : /guides/publier/
|
|
118
118
|
|
|
119
|
-
# Publier avec
|
|
119
|
+
# Publier avec Host
|
|
120
120
|
|
|
121
|
-
|
|
121
|
+
Host construit ton site à chaque push et le sert depuis son serveur. La console `docs.hgdc.ch` relit ensuite le site publié pour indexer l’assistant.
|
|
122
122
|
|
|
123
123
|
## Mettre la doc en ligne
|
|
124
124
|
|
|
125
125
|
1. **Importer le dépôt**
|
|
126
126
|
|
|
127
|
-
Dans
|
|
127
|
+
Dans Host, crée un projet à partir de ton dépôt GitHub. Host reconnaît une doc Docs (un `docs.json` et le paquet `@hgdc/docs` dans `package.json`) : il la construit avec `hgdc-docs build` et publie le dossier `dist/`. Aucun fichier de configuration à ajouter.
|
|
128
128
|
|
|
129
129
|
2. **Fusionner la pull request de Host**
|
|
130
130
|
|
|
@@ -134,11 +134,11 @@ HGDC Host construit ton site à chaque push et le sert depuis son serveur. La co
|
|
|
134
134
|
|
|
135
135
|
Chaque push sur la branche principale publie le site en production. Les autres branches ont leur préversion.
|
|
136
136
|
|
|
137
|
-
## Activer
|
|
137
|
+
## Activer Docs
|
|
138
138
|
|
|
139
139
|
1. **Cliquer sur « Activer Docs »**
|
|
140
140
|
|
|
141
|
-
Sur la vue d’ensemble du projet dans
|
|
141
|
+
Sur la vue d’ensemble du projet dans Host, la carte **Assistant et recherche avec Docs** propose **Activer Docs**. Host crée le projet dans la console, dans la même organisation. Il faut être admin de l’organisation, et la doc doit déjà être en production.
|
|
142
142
|
|
|
143
143
|
2. **Publier une fois de plus**
|
|
144
144
|
|
|
@@ -146,7 +146,7 @@ HGDC Host construit ton site à chaque push et le sert depuis son serveur. La co
|
|
|
146
146
|
|
|
147
147
|
3. **Laisser faire**
|
|
148
148
|
|
|
149
|
-
À chaque mise en production, Host prévient la console, qui relit `/_hgdc/corpus.json` et indexe les pages en quelques secondes. La carte de Host affiche **
|
|
149
|
+
À chaque mise en production, Host prévient la console, qui relit `/_hgdc/corpus.json` et indexe les pages en quelques secondes. La carte de Host affiche **Docs est activé** et mène à la console. En plus, la console relit le site tous les quarts d’heure : un appel perdu se rattrape seul.
|
|
150
150
|
|
|
151
151
|
> **Note**
|
|
152
152
|
>
|
|
@@ -154,11 +154,11 @@ HGDC Host construit ton site à chaque push et le sert depuis son serveur. La co
|
|
|
154
154
|
|
|
155
155
|
## Ton domaine
|
|
156
156
|
|
|
157
|
-
Le domaine se branche dans
|
|
157
|
+
Le domaine se branche dans Host, comme pour n’importe quel site : Host annonce la nouvelle adresse à la console à la mise en production suivante. Si la doc répond sur plusieurs adresses (`docs.acme.ch` et `aide.acme.ch`), ajoute les autres dans **Réglages › Domaines** : l’assistant ne répond qu’aux pages servies par ces adresses.
|
|
158
158
|
|
|
159
159
|
## Relier un projet existant
|
|
160
160
|
|
|
161
|
-
Le dossier `dist/` est un site statique, il se dépose chez n’importe quel hébergeur. Hors de
|
|
161
|
+
Le dossier `dist/` est un site statique, il se dépose chez n’importe quel hébergeur. Hors de Host, ou pour un projet créé directement dans la console, relie la doc à la main.
|
|
162
162
|
|
|
163
163
|
1. **Créer le projet dans la console**
|
|
164
164
|
|
|
@@ -196,7 +196,7 @@ Le haut de la page, entre deux lignes `---`, décrit la page.
|
|
|
196
196
|
|
|
197
197
|
```mdx
|
|
198
198
|
---
|
|
199
|
-
title: Publier avec
|
|
199
|
+
title: Publier avec Host
|
|
200
200
|
sidebarTitle: Publier
|
|
201
201
|
description: Mettre la doc en ligne et brancher l'assistant.
|
|
202
202
|
---
|
|
@@ -446,7 +446,7 @@ Pour une couleur différente en mode sombre, ajoute `"dark": "#5eead4"`.
|
|
|
446
446
|
|
|
447
447
|
> **Note**
|
|
448
448
|
>
|
|
449
|
-
> Dans la console, **Réglages › Thème** montre l’effet d’une couleur en clair et en sombre, et prépare la ligne à copier dans `docs.json`.
|
|
449
|
+
> Dans la console, **Réglages › Thème** montre l’effet d’une couleur en clair et en sombre, son contraste sur un fond blanc, et prépare la ligne à copier dans `docs.json`.
|
|
450
450
|
|
|
451
451
|
## Logo
|
|
452
452
|
|
|
@@ -495,10 +495,12 @@ L’assistant est actif dès que `docs.json` porte l’identifiant `project` et
|
|
|
495
495
|
|
|
496
496
|
Chaque organisation dispose d’un nombre de questions par mois, toutes docs confondues : 500 dans l’offre de départ. La console affiche la consommation. Au-delà, l’assistant répond qu’il a atteint sa limite, et HGDC relève le plafond sur demande.
|
|
497
497
|
|
|
498
|
-
Pour éviter qu’un seul visiteur épuise le quota, chaque visiteur a droit à 6 questions par minute, et chaque doc à 30.
|
|
498
|
+
Pour éviter qu’un seul visiteur ou un script épuise le quota, chaque visiteur a droit à 6 questions par minute et 40 par jour, et chaque doc à 30 par minute et 200 par jour. HGDC relève le plafond journalier d’une doc sur demande.
|
|
499
499
|
|
|
500
500
|
## Tester et lire le journal
|
|
501
501
|
|
|
502
|
+
En haut de la page **Assistant**, les 30 derniers jours : nombre de questions, part de réponses sourcées, et les **questions sans réponse**, regroupées et classées de la plus posée à la moins posée. Chacune ouvre le journal filtré : c’est la liste des pages à écrire.
|
|
503
|
+
|
|
502
504
|
**Assistant › Tester l’assistant** pose une question comme un visiteur. Le **journal** garde les questions des 90 derniers jours avec leur état :
|
|
503
505
|
|
|
504
506
|
| État | Ce que ça veut dire |
|
|
@@ -507,6 +509,8 @@ Pour éviter qu’un seul visiteur épuise le quota, chaque visiteur a droit à
|
|
|
507
509
|
| Hors doc | Rien dans la doc ne répond. Souvent une page à écrire. |
|
|
508
510
|
| Erreur | Le modèle n’a pas répondu ; le visiteur a été invité à réessayer. |
|
|
509
511
|
|
|
512
|
+
Au-dessus du journal, cherche une question par ses mots, ou filtre par état : **État › Hors doc** ne garde que les questions sans réponse. Les filtres restent dans l’adresse de la page : tu peux la garder en favori ou l’envoyer à un collègue.
|
|
513
|
+
|
|
510
514
|
> **Astuce**
|
|
511
515
|
>
|
|
512
516
|
> Lis les questions « hors doc » une fois par semaine : c’est la liste des pages qui manquent, écrite par tes visiteurs.
|
|
@@ -517,7 +521,7 @@ Source : /guides/agents/
|
|
|
517
521
|
|
|
518
522
|
# llms.txt et MCP
|
|
519
523
|
|
|
520
|
-
Les assistants de code et les agents lisent la documentation pour écrire du code juste.
|
|
524
|
+
Les assistants de code et les agents lisent la documentation pour écrire du code juste. Docs leur donne trois portes d’entrée, sans rien à configurer.
|
|
521
525
|
|
|
522
526
|
## llms.txt
|
|
523
527
|
|
|
@@ -546,6 +550,20 @@ Dans Claude Code :
|
|
|
546
550
|
claude mcp add --transport http acme-docs https://docs.hgdc.ch/mcp/<identifiant du projet>
|
|
547
551
|
```
|
|
548
552
|
|
|
553
|
+
Dans Cursor (`.cursor/mcp.json`) :
|
|
554
|
+
|
|
555
|
+
```json
|
|
556
|
+
{ "mcpServers": { "acme-docs": { "url": "https://docs.hgdc.ch/mcp/<identifiant du projet>" } } }
|
|
557
|
+
```
|
|
558
|
+
|
|
559
|
+
Dans VS Code (`.vscode/mcp.json`) :
|
|
560
|
+
|
|
561
|
+
```json
|
|
562
|
+
{ "servers": { "acme-docs": { "type": "http", "url": "https://docs.hgdc.ch/mcp/<identifiant du projet>" } } }
|
|
563
|
+
```
|
|
564
|
+
|
|
565
|
+
L’aperçu du projet donne ces lignes déjà remplies. Le serveur reste ouvert quand l’assistant du site est coupé : il ne fait que chercher, sans modèle.
|
|
566
|
+
|
|
549
567
|
Le serveur propose trois outils :
|
|
550
568
|
|
|
551
569
|
| Outil | Rôle |
|
|
@@ -562,24 +580,28 @@ Source : /reference/docs-json/
|
|
|
562
580
|
|
|
563
581
|
# docs.json
|
|
564
582
|
|
|
565
|
-
`docs.json` vit à la racine du dossier de la doc. Il reprend le format de Mintlify : les champs que
|
|
583
|
+
`docs.json` vit à la racine du dossier de la doc. Il reprend le format de Mintlify : les champs que Docs ne gère pas sont acceptés et ignorés. Pour l’autocomplétion dans ton éditeur, ajoute `"$schema": "https://docs.hgdc.ch/docs.schema.json"`.
|
|
566
584
|
|
|
567
585
|
## Champs
|
|
568
586
|
|
|
569
|
-
| Champ | Type
|
|
570
|
-
| -------------------- |
|
|
571
|
-
| `name` | texte
|
|
572
|
-
| `description` | texte
|
|
573
|
-
| `navigation` | objet
|
|
574
|
-
| `project` | texte
|
|
575
|
-
| `language` | `fr`, `en`, `de`, `it`
|
|
576
|
-
| `
|
|
577
|
-
| `colors.
|
|
578
|
-
| `
|
|
579
|
-
| `
|
|
580
|
-
| `
|
|
581
|
-
| `
|
|
582
|
-
| `
|
|
587
|
+
| Champ | Type | Obligatoire | Rôle |
|
|
588
|
+
| -------------------- | --------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
589
|
+
| `name` | texte | oui | Nom de la doc, en tête du site et dans `llms.txt`. 80 caractères au plus. |
|
|
590
|
+
| `description` | texte | non | Une phrase de présentation. |
|
|
591
|
+
| `navigation` | objet | oui | Pages, groupes, onglets ou versions. Voir [Navigation](/guides/navigation/). |
|
|
592
|
+
| `project` | texte | non | Identifiant du projet dans la console. Active l’assistant et l’indexation. |
|
|
593
|
+
| `language` | `fr`, `en`, `de`, `it` | non | Langue de l’interface du site. `fr` par défaut. |
|
|
594
|
+
| `base` | texte | non | Sous-chemin où la doc est servie, par exemple `/docs` quand ton application la publie derrière un proxy (`https://app.acme.ch/docs`). Liens, images, recherche, `llms.txt` et pages `.md` le portent ; le site est écrit dans `dist/docs/`. Écris tes liens depuis la racine de la doc (`/guides/publier/`) : le sous-chemin est ajouté au build. |
|
|
595
|
+
| `colors.primary` | couleur `#rrggbb` | non | Couleur des liens et des éléments actifs. |
|
|
596
|
+
| `colors.dark` | couleur `#rrggbb` | non | La même, en mode sombre. |
|
|
597
|
+
| `logo` | chemin, ou `{ light, dark }` | non | Logo affiché en tête. |
|
|
598
|
+
| `favicon` | chemin | non | Icône de l’onglet du navigateur. |
|
|
599
|
+
| `navbar.links` | liste de `{ label, href }` | non | Jusqu’à 5 liens dans la barre du haut (adresses complètes). |
|
|
600
|
+
| `navbar.primary` | `{ label, href }` | non | Bouton mis en avant à droite de la barre du haut. |
|
|
601
|
+
| `footer.socials` | objet | non | Liens vers tes réseaux : `linkedin`, `github`, `gitlab`, `x`, `youtube`, `instagram`, `facebook`, `discord`, `mastodon`, `bluesky`, `website`. |
|
|
602
|
+
| `redirects` | liste de `{ source, destination, permanent }` | non | Anciennes adresses qui mènent aux nouvelles. `source` est un chemin du site (`/guides/ancien`), `destination` un chemin ou une adresse `https://`. `permanent: false` pour une redirection temporaire. 500 au plus. |
|
|
603
|
+
| `assistant.enabled` | oui / non | non | `false` cache l’assistant du site. |
|
|
604
|
+
| `assistant.endpoint` | adresse | non | API de l’assistant, à ne changer que pour un environnement de test. |
|
|
583
605
|
|
|
584
606
|
## Navigation
|
|
585
607
|
|
|
@@ -624,11 +646,11 @@ Options : `--port 4000` change le port de `dev` et `preview`, `--help` affiche l
|
|
|
624
646
|
|
|
625
647
|
## Variables d’environnement
|
|
626
648
|
|
|
627
|
-
| Variable | Rôle
|
|
628
|
-
| ---------------- |
|
|
629
|
-
| `HGDC_DOCS_SITE` | Adresse publique du site (`https://docs.acme.ch`). Rend les liens de `llms.txt` absolus et produit le sitemap. Sur
|
|
630
|
-
| `HGDC_DOCS_OUT` | Dossier de sortie, `dist/` par défaut.
|
|
631
|
-
| `HGDC_DOCS_API` | API de l’assistant, `https://docs.hgdc.ch` par défaut.
|
|
649
|
+
| Variable | Rôle |
|
|
650
|
+
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
651
|
+
| `HGDC_DOCS_SITE` | Adresse publique du site (`https://docs.acme.ch`). Rend les liens de `llms.txt` absolus et produit le sitemap. Sur Host, l’adresse de production est reprise seule. |
|
|
652
|
+
| `HGDC_DOCS_OUT` | Dossier de sortie, `dist/` par défaut. |
|
|
653
|
+
| `HGDC_DOCS_API` | API de l’assistant, `https://docs.hgdc.ch` par défaut. |
|
|
632
654
|
|
|
633
655
|
## Ce que contient dist/
|
|
634
656
|
|
|
@@ -680,10 +702,10 @@ L’en-tête `Origin` doit être l’adresse du site ou un des domaines déclar
|
|
|
680
702
|
{
|
|
681
703
|
"id": "j97f…",
|
|
682
704
|
"status": "answered",
|
|
683
|
-
"answer": "Importe le dépôt dans
|
|
705
|
+
"answer": "Importe le dépôt dans Host[^1], puis synchronise le projet dans la console[^2].",
|
|
684
706
|
"sources": [
|
|
685
|
-
{ "n": 1, "title": "Publier avec
|
|
686
|
-
{ "n": 2, "title": "Publier avec
|
|
707
|
+
{ "n": 1, "title": "Publier avec Host", "section": "Avec Host", "url": "https://docs.acme.ch/guides/publier/#avec-host" },
|
|
708
|
+
{ "n": 2, "title": "Publier avec Host", "section": "Relier la console", "url": "https://docs.acme.ch/guides/publier/#relier-la-console" }
|
|
687
709
|
]
|
|
688
710
|
}
|
|
689
711
|
```
|
|
@@ -765,7 +787,7 @@ Source : /explications/fonctionnement/
|
|
|
765
787
|
|
|
766
788
|
# Comment ça marche
|
|
767
789
|
|
|
768
|
-
|
|
790
|
+
Docs tient en trois pièces : un modèle de site, Host qui le publie, et la console qui l’indexe pour l’assistant.
|
|
769
791
|
|
|
770
792
|
## 1. Le modèle de site
|
|
771
793
|
|
|
@@ -773,9 +795,9 @@ Le paquet `@hgdc/docs` contient un site Astro Starlight complet. `hgdc-docs buil
|
|
|
773
795
|
|
|
774
796
|
Pendant le build, chaque page est aussi convertie en Markdown à partir du HTML final. Les composants sont donc déjà rendus : ce que lit un agent est exactement ce que voit un visiteur.
|
|
775
797
|
|
|
776
|
-
## 2. La publication par
|
|
798
|
+
## 2. La publication par Host
|
|
777
799
|
|
|
778
|
-
|
|
800
|
+
Host lance le build dans GitHub Actions à chaque push, puis sert le dossier `dist/` sur ton domaine. La doc est une source comme une autre : préversion par branche, retour arrière, domaine.
|
|
779
801
|
|
|
780
802
|
## 3. L’indexation par la console
|
|
781
803
|
|
|
@@ -814,7 +836,7 @@ La console ne stocke ni l’adresse IP ni l’identité des visiteurs. L’IP se
|
|
|
814
836
|
|
|
815
837
|
## Qui traite quoi
|
|
816
838
|
|
|
817
|
-
- **Le site** est servi par
|
|
839
|
+
- **Le site** est servi par Host.
|
|
818
840
|
- **La recherche du site** tourne dans le navigateur du visiteur : aucune requête ne part.
|
|
819
841
|
- **Les embeddings** des passages et des questions sont calculés par Mistral AI, dans l’Union européenne.
|
|
820
842
|
- **Les réponses** sont rédigées par Claude, le modèle d’Anthropic, appelé directement ou par OpenRouter. La question et les passages trouvés lui sont envoyés.
|
package/template/.build/llms.txt
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Docs
|
|
2
2
|
|
|
3
|
-
> Écrire une documentation en MDX, la publier avec
|
|
3
|
+
> Écrire une documentation en MDX, la publier avec Host et y brancher un assistant IA qui cite ses sources.
|
|
4
4
|
|
|
5
5
|
Chaque page existe en Markdown à la même adresse suivie de `.md`. `llms-full.txt` contient toute la documentation en un seul fichier.
|
|
6
6
|
|
|
7
7
|
## Guides · Démarrer
|
|
8
8
|
|
|
9
|
-
- [Bienvenue dans
|
|
9
|
+
- [Bienvenue dans Docs](/index.md): Ta documentation en MDX, publiée par Host, avec recherche, llms.txt et un assistant IA qui cite ses sources.
|
|
10
10
|
- [Ta première doc en cinq minutes](/demarrer/premiere-doc.md): Créer le dossier, écrire docs.json et une page, puis voir le site en local.
|
|
11
|
-
- [Publier avec
|
|
11
|
+
- [Publier avec Host](/guides/publier.md): Mettre la doc en ligne avec Host, activer Docs en un clic et brancher l'assistant.
|
|
12
12
|
|
|
13
13
|
## Guides · Écrire
|
|
14
14
|
|
|
@@ -24,7 +24,7 @@ Chaque page existe en Markdown à la même adresse suivie de `.md`. `llms-full.t
|
|
|
24
24
|
|
|
25
25
|
## Référence · Configuration
|
|
26
26
|
|
|
27
|
-
- [docs.json](/reference/docs-json.md): Tous les champs du fichier de configuration d'un site
|
|
27
|
+
- [docs.json](/reference/docs-json.md): Tous les champs du fichier de configuration d'un site Docs.
|
|
28
28
|
- [La commande hgdc-docs](/reference/cli.md): Les commandes dev, build et preview, et les variables d'environnement du build.
|
|
29
29
|
|
|
30
30
|
## Référence · API
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"1.5.2","languages":{"fr-ch":{"hash":"fr-
|
|
1
|
+
{"version":"1.5.2","languages":{"fr-ch":{"hash":"fr-ch_8a246aa922758","wasm":"fr-ch","page_count":15}},"include_characters":["_","‿","⁀","⁔","︳","︴","﹍","﹎","﹏","＿"]}
|
|
Binary file
|