Official documentation for the oplog.one (Omnitro OpenAPI) platform. This documentation site provides comprehensive guides and API reference for developers integrating with oplog.one services.
- Complete API reference with interactive endpoints
- Developer guides and tutorials
- OpenAPI specification integration
- Responsive design with dark/light themes
- Node.js version 20.17.0 or higher
- Global Mintlify CLI installation
Node.js Version Requirement:
This project requires Node.js v20.17.0 or higher. Use the included .nvmrc file:
nvm use v20.17.0
nvm alias default v20.17.0Install Mintlify CLI:
npm i -g mintlify@latestStart development server (local only):
mintlify devStart server on network (accessible from other devices):
mintlify dev --host 0.0.0.0 --port 3000Use convenience scripts:
./dev.sh # Local development with version check
./dev-network.sh # Network development with IP displayInstall/reinstall dependencies:
mintlify installCheck for broken links:
mintlify broken-linksWhen running with --host 0.0.0.0, the documentation becomes accessible from:
- Same computer:
http://localhost:3000 - Other devices on network:
http://YOUR_IP_ADDRESS:3000
Find your IP address:
# macOS/Linux
ifconfig | grep "inet " | grep -v 127.0.0.1
# Windows
ipconfig | findstr "IPv4"Documentation changes are automatically deployed to production when pushed to the default branch.
- Mintlify dev isn't running: Run
mintlify installto re-install dependencies - Page loads as a 404: Make sure you are running in a folder with
docs.json - Node/Sharp issues: Remove global mintlify, upgrade Node.js, reinstall mintlify
- Firewall issues: Ensure port 3000 is open for network access