Ajouter des pages et des sections

0:00 / 0:19

Créer un fichier

Les dossiers construisent l’URL. Un dossier est un segment de route, pas une section de la barre latérale.

docs/guides/webhooks.md

---
title: Recevoir des webhooks
sidebarTitle: Webhooks
description: Vérifier et traiter les événements.
---

## Vérifier la signature

Rejetez toute livraison sans signature valide.

L’ajouter à la navigation

La navigation est indépendante de l’arborescence. On désigne les pages par leur slug.

specistry.config.ts

navigation: [
  "quickstart",
  { section: "Guides", items: [
    "guides/webhooks",
    { page: "guides/ci", label: "CI" },
  ] },
  { api: true, label: "Référence API" },
  { label: "Statut", link: "https://status.acme.dev" },
],

Valider
Chaque problème de navigation pointe vers le chemin dans la config, par exemple config#/navigation/1/items/0.
terminal
```
npx specistry validate
```

Les types d’entrées

Entrée	Rôle
`"slug"`	Une page ; libellé = `sidebarTitle` ou `title`
`{ page, label? }`	Une page avec un libellé explicite
`{ section, items }`	Un groupe titré — deux niveaux maximum
`{ api: true, label? }`	La référence API générée, une seule fois
`{ label, link }`	Un lien externe `https://` ou `http://`

Cas particuliers

Page référencée mais fichier absent

NAVIGATION_PAGE_MISSING

✕ ÉCHOUE

specistry.config.ts

{ section: "Guides", items: ["guides/webhook"] }

✓ CORRECTION

specistry.config.ts

{ section: "Guides", items: ["guides/webhooks"] }

Le slug ne correspond à aucun fichier (il manque le « s »).

Trois niveaux de sections

NAVIGATION_DEPTH_EXCEEDED

✕ ÉCHOUE

specistry.config.ts

{ section: "A", items: [{ section: "B", items: [
  { section: "C", items: ["x"] } ] }] }

✓ CORRECTION

specistry.config.ts

{ section: "A", items: [{ section: "B · C", items: ["x"] }] }

Les sections s’imbriquent sur deux niveaux au maximum.

Deux entrées API

NAVIGATION_API_DUPLICATE

✕ ÉCHOUE

specistry.config.ts

{ api: true, label: "Référence" },
{ api: true, label: "Endpoints" },

✓ CORRECTION

specistry.config.ts

{ api: true, label: "Référence API" },

La référence API n’apparaît qu’à un seul endroit.

Une page oubliée

NAVIGATION_PAGE_ORPHANED · avertissement

✕ ÉCHOUE

docs/

docs/guides/relances.md   # absente de la navigation

✓ CORRECTION

specistry.config.ts

{ section: "Guides", items: ["guides/webhooks", "guides/relances"] }

Toujours accessible par URL, mais invisible dans la barre latérale. Pratique pour une page cachée.