Description

Goals

• Automate the generation of API documentation for NX services.
• Provide an interactive, responsive user interface for exploring code-level API structures.
• Ensure documentation stays synchronized with the codebase across refactors and updates.

• Automatiser la génération de documentation API pour les services NX.
• Fournir une interface interactive et responsive pour explorer les structures d'API au niveau du code.
• S'assurer que la documentation reste synchronisée avec le codebase à travers les refactorisations et mises à jour.

Features

• Auto-generated documentation: A custom CLI scans and parses service modules, producing structured JSON used to build an API reference interface.
• Type-aware parsing: Utilizes the TypeScript Compiler API to extract detailed metadata including parameter types, return values, default arguments, and JSDoc annotations.
• Modular support: Supports both client-side and server-side modules, organizing documentation based on service type and project structure.
• Method introspection: Provides complete method signature details including descriptions, return types, and examples extracted from source annotations.
• UI-centric documentation interface: A modern documentation frontend built with Next.js, SCSS, Recoil and Framer Motion, focused on performance and maintainability.
• Live documentation updates: Changes in the codebase are immediately reflected in the documentation after running the CLI, with support for localization and scoped environments.

• Documentation auto-générée: Un CLI personnalisé scanne et analyse les modules de service, produisant du JSON structuré pour construire une interface de référence API.
• Analyse consciente des types: Utilise l'API TypeScript Compiler pour extraire des métadonnées détaillées : types de paramètres, valeurs de retour, arguments par défaut et annotations JSDoc.
• Support modulaire: Prend en charge les modules côté client et serveur, organisant la documentation selon le type de service et la structure du projet.
• Introspection des méthodes: Fournit des détails complets sur les signatures de méthodes : descriptions, types de retour et exemples extraits des annotations source.
• Interface de documentation centrée sur l'UI: Un frontend de documentation moderne construit avec Next.js, SCSS, Recoil et Framer Motion.
• Mises à jour en direct: Les changements dans le codebase sont immédiatement reflétés après exécution du CLI, avec prise en charge de la localisation et des environnements scopés.

Learning outcomes

• Developed static analysis tooling with the TypeScript Compiler API.
• Created CLI utilities to automate service metadata extraction.
• Implemented a scalable documentation system that remains in sync with source code.

• Développement d'outillage d'analyse statique avec l'API TypeScript Compiler.
• Création d'utilitaires CLI pour automatiser l'extraction de métadonnées de services.
• Implémentation d'un système de documentation scalable qui reste synchronisé avec le code source.