Welcome to the official documentation repository for Spotflow, a comprehensive Merchant of Record solution for global merchants and businesses looking to expand. This documentation is built with Mintlify and covers everything from quick start guides to detailed API references.
Visit our live documentation at docs.spotflow.one
Our documentation is organized into five main sections:
- Getting started guides
- Platform features (subscriptions, one-time payments, disbursements, etc.)
- Business verification
- Integration guides and tutorials
- SDKs and mobile integration
- Testing tools
- Complete API documentation
- Endpoint references for all resources
- Error codes and troubleshooting
- Code examples and best practices
- Version history
- Feature updates
- Breaking changes
- Migration guides
- Node.js 18.x or higher
- npm or yarn package manager
-
Clone the repository
git clone https://github.com/spotflow-one/spotflow.git cd spotflow-docs -
Install the Mintlify CLI
npm i -g mintlify # or yarn global add mintlify -
Run the development server
mintlify dev
The documentation will be available at
http://localhost:3000
The documentation is configured through docs.json which includes:
- Navigation structure
- Theme customization
- SEO settings
- Integration configurations
- Redirect rules
Want to help improve our docs? Read our contribution guidelines for details on how to get started.
- Fix typos, clarify explanations, or add examples
- Create new guides or update API docs
- Help with translations
All docs use MDX with frontmatter. Test changes locally with mintlify dev before submitting a pull request.
A heartfelt thank you to all our contributors for their valuable contributions and ongoing support!
Mintlify dev isn't running
- Run
mintlify installto reinstall dependencies - Ensure you're in the directory containing
docs.json
Page loads as 404
- Check that your file is included in the navigation structure in
docs.json - Verify the file path matches the navigation entry
Images not displaying
- Ensure images are in the
/imagesdirectory - Use absolute paths starting with
/images/
Documentation is automatically deployed when changes are pushed to the main branch. The deployment process:
- Push changes to the
mainbranch - GitHub Actions trigger the build process
- Mintlify deploys the updated documentation
- Changes are live at docs.spotflow.one
This documentation is licensed under the GNU General Public License v3.0 (GPL-3.0). See the LICENSE file for details.
- Documentation Issues: Open an issue in this repository
- Community: Join our Slack community