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.

npx docusaurus gen-api-docs all

This command generated the documentation files in docs/developers/apis/for Ottu APIs from static/Ottu_API.yaml.

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

1. Create a new branch for your changes
2. Make your edits to the documentation
3. Test locally with npm start
4. Create a pull request
5. Preview will be automatically generated for your branch

docs/
├── overview/          # About Ottu, Architecture, Changelog
├── developers/        # API documentation and developer guides
├── business/          # Dashboard and business user guides
├── glossary/          # Payment terminology and concepts
└── resources/         # Support, tools, and additional resources