ENFR0.1.0-rc.3

Structure du projet

Où placer les fichiers, et quelles routes ils produisent.


acme-docs/
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 modifier

Rè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
  • index désigne la route du dossier
  • Seuls les .md et .mdx sont lus ; fichiers cachés et node_modules ignoré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
✕ ÉCHOUE
docs/
docs/Prise_En_Main.md
✓ CORRECTION
docs/
docs/prise-en-main.md

Le nom de fichier doit déjà être un slug valide.

Deux fichiers pour la même route

ROUTE_COLLISION
✕ ÉCHOUE
docs/
docs/setup.md
docs/setup.mdx
✓ CORRECTION
docs/
docs/setup.mdx

Les deux donnent /docs/setup.

Lien symbolique hors du dossier docs

CONTENT_SOURCE_OUTSIDE_ROOT
✕ ÉCHOUE
docs/
docs/commun.md -> ../../wiki/commun.md
✓ CORRECTION
docs/
# copiez le fichier dans docs/

Les sources doivent rester dans le dossier docs.

Signaler un problème sur cette page (GitHub)