This documentation site is built using Docusaurus, a modern static website generator.
npm install
npm start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
npm run build
This command generates static content into the build
directory and can be served using any static contents hosting service.
npm run typecheck
npm run serve
This project uses GitHub Actions for automated deployment to GitHub Pages. The deployment happens automatically:
- Production: Deployments from the
main
branch go to the main site - Preview: Deployments from other branches create preview environments
npm run deploy
- Create a new branch for your changes
- Make your edits to the documentation
- Test locally with
npm start
- Create a pull request
- Preview will be automatically generated for your branch
docs/
├── overview/ # About Ottu, Architecture, Changelog
├── quick-start/ # Developer & Merchant quick start guides
├── developers/ # API documentation and developer guides
├── business/ # Dashboard and business user guides
├── glossary/ # Payment terminology and concepts
└── resources/ # Support, tools, and additional resources