How nolanbeaujault/cortest-docs works
Project type and purpose
• This is a documentation website built with Docusaurus (a React-based static site generator).
• Purpose: serve technical docs (MDX, custom TSX pages, assets) for the Cortest mobile seizure testing platform, hosted on GitHub Pages.
File structure
• Top-level:
• docs/ – all MDX documentation pages, organized into backend/frontend categories.
• src/pages/ – custom React/TSX pages and layouts (e.g., team page, gestion_tests).
• static/ – images, fonts, assets copied verbatim to output.
• docusaurus.config.js & sidebars.js – config and sidebar definitions.
• package.json – dependencies (Docusaurus, React, MDX, etc.) and build scripts.
README for additional insights
• Confirms tech stack: Docusaurus v3.8.1, React 18, MDX, custom CSS.
• Dev workflow: npm run start (local dev server), npm run build + npm run deploy (GitHub Pages CI/CD).
• Structure summary matches file tree.
Main components
a. Local Development Environment
• Node.js runtime + NPM packages
• Docusaurus CLI / dev server (hot-reload)
b. Content Sources
• docs/ MDX files
• src/pages/ custom TSX pages
• static/ assets (images, fonts, CSS)
c. Build Pipeline
• MDX → JSX transformer
• React + Webpack bundling
• Docusaurus theming + plugin system
d. Deployment Target
• GitHub Actions or CI/CD runner
• GitHub Pages hosting (static site)
Relationships & Data Flow
• Build Pipeline → generates static output (HTML, JS bundles, CSS, assets).
• Deployment step pushes output to GitHub Pages.
• Local Development step runs same pipeline in memory and serves via localhost:3000.
Architectural patterns & design principles
• Static Site Generation (SSG) – all pages pre-rendered at build time.
• Component-based UI (React) – reuse via src/components.
• MDX for composable docs (mix Markdown + JSX).
• Configuration-driven (docusaurus.config.js, sidebars.js) for routing & theming.