How cuemeet/cuemeet-documentation works
Project Type and Purpose
• This is a static documentation website built with Docusaurus (a React-based SSG).
• It hosts CueMeet’s API references (openapi.yaml), markdown guides (docs/), custom React components (src/), and static assets (static/).
File-Structure Analysis
• Top-Level:
• .github/workflows – CI for PR checks and automated docs deployment
• Dockerfile – containerize the docs app
• openapi.yaml – OpenAPI spec driving API reference pages
• docs/ – markdown sources for guides & auto-generated API pages
• src/ – React components & MDX pages for custom UI
• static/ – images and other assets
• docusaurus.config.ts, sidebars.ts – site configuration & navigation
• Scripts & Config: package.json defines start/build/deploy scripts; workflows invoke those in CI.
Key README Insights
• Supports two dev modes: Docker‐based (docker build + docker run) and native Node.js/Yarn (yarn start).
• Build targets static site (npm run build), serve locally (npm run serve), and deploy (npm run deploy).
• The repo deploys via GitHub Actions to production (likely GH Pages or another static host).