Skip to content

docs: migrate full documentation to dedicated docs/ directory - #19

Merged
atinseau merged 1 commit into
masterfrom
docs/migrate-documentation-to-docs
Mar 12, 2026
Merged

atinseau merged 1 commit into
masterfrom
docs/migrate-documentation-to-docs

Conversation

@atinseau

Copy link
Copy Markdown
Owner

Changements apportés

  • Suppression du contenu détaillé de README.md : table des matières, toutes les sections de référence (analyse statique, inférence de schéma de sortie, fonctionnalités du schéma, helpers, identifiants, templates objet, coercion, gestion des erreurs, API de configuration) et leurs exemples de code
  • Mise à jour du code d'exemple dans README.md pour inclure un cas engine.execute() illustrant la préservation des types à l'exécution
  • Création du répertoire docs/ avec 10 nouveaux fichiers Markdown :
    • getting-started.md — installation et démarrage rapide
    • static-analysis.md — validation de l'entrée et inférence du schéma de sortie
    • execution.md — exécution et préservation des types
    • helpers.md — helpers de bloc, mathématiques, comparaison et logiques
    • identifiers.md — identifiants de template {{key:N}}
    • schema-features.md — $ref, combinateurs, additionalProperties, .length
    • templates.md — templates objet et templates compilés
    • api-reference.md — référence complète de l'API
    • error-handling.md — gestion des erreurs
    • advanced.md — fonctionnalités avancées

Remarques

Le README.md est désormais un aperçu concis du projet. L'intégralité de la documentation de référence a été déplacée dans docs/ pour une meilleure navigabilité et maintenabilité.

🚀

@atinseau
atinseau merged commit b21b458 into master Mar 12, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant