Development Pipeline
Prerequisites​
Before working with the documentation, ensure you have the required development tools installed and configured.
See: Prerequisites - Development Tools for complete setup instructions.
Building Documentation​
The documentation can be built independently from the frontend applications. From the project root, run the following command:
make build_docs
This command:
- Builds frontend packages (required dependencies)
- Generates API specifications from OpenAPI files
- Builds the Docusaurus site
Output: Built documentation in docs/build/
Development Server​
Start the documentation development server with live reload:
cd docs
pnpm dev
The documentation will be available at http://localhost:3000.
Features during development:
- Hot Reload: Changes appear instantly without refresh
- Fast Feedback: See your edits in real-time
- Error Reporting: Clear error messages for invalid MDX
Available Scripts​
From the docs/ directory, you can run:
| Command | Description |
|---|---|
pnpm dev | Start development server with live reload |
pnpm build | Build production-ready documentation |
pnpm serve | Serve built documentation locally |
pnpm clear | Clear Docusaurus cache |
pnpm typecheck | Run TypeScript type checking |
pnpm lint | Run ESLint on documentation files |
pnpm lint:fix | Auto-fix linting issues |
pnpm generate:api-specs | Generate merged API specifications |