Structure du projet
Où placer les fichiers, et quelles routes ils produisent.
acme-docs/
├── specistry.config.ts # code de build de confiance
├── openapi.yaml # contrat (facultatif)
├── docs/ # pages rédigées (./docs par défaut)
│ ├── index.md # → /
│ ├── quickstart.mdx # → /docs/quickstart
│ ├── images/
│ │ └── premier-email.gif
│ └── guides/
│ ├── index.md # → /docs/guides
│ └── webhooks.md # → /docs/guides/webhooks
├── changelog/
│ └── v2.json # notes de version rédigées
└── .specistry/artifacts/ # sortie du build — ne pas modifierRègles de nommage des routes
- Lettres minuscules et chiffres, séparés par un tiret simple, 80 caractères max par segment
- Quatre segments de profondeur au maximum
indexdésigne la route du dossier- Seuls les
.mdet.mdxsont lus ; fichiers cachés etnode_modulesignorés - Sans
docs/index.*, la référence API générée sert de page d’accueil
Cas particuliers
Majuscules ou underscores dans un nom de fichier
ROUTE_SLUG_INVALID✕ ÉCHOUEdocs/
docs/Prise_En_Main.md✓ CORRECTIONdocs/
docs/prise-en-main.mdLe nom de fichier doit déjà être un slug valide.
Deux fichiers pour la même route
ROUTE_COLLISION✕ ÉCHOUEdocs/
docs/setup.md
docs/setup.mdx✓ CORRECTIONdocs/
docs/setup.mdxLes deux donnent /docs/setup.
Lien symbolique hors du dossier docs
CONTENT_SOURCE_OUTSIDE_ROOT✕ ÉCHOUEdocs/
docs/commun.md -> ../../wiki/commun.md✓ CORRECTIONdocs/
# copiez le fichier dans docs/Les sources doivent rester dans le dossier docs.