This is the official Mojaloop Community Business Documentation for the Mojaloop project.
This document is part of the Mojaloop Community Business Document Project. The project is intended to support entities (countries, regions, associations of providers or commercial enterprises) implementing new payments systems using Mojaloop code. These entities will also need write Scheme, Business Rules that participants in the system will follow.
The Mojaloop Community Business Document Project provides templates for Scheme, Business Rules and related documents. There are many choices involved in implementing a new payment system: the templates show some of the choices and, where appropriate, commentary is provided on how the particular choice is related to the goals of a Level One aligned system.
Notes: This document is a work-in-progress.
This repository contains a set of templates for business documents. These are intended as guidance to businesses or agencies who are evaluating the creation of a real-time retail payment system, enabled by Mojaloop open source software. The documents are likely more broadly useful than that, though they were created to complement and guide the practical application of the Mojaloop software.
Our updated docs currently live in the ./docs directory
# install dependencies
yarn
# run the local server
yarn run devRun yarn run build to build the project to render the static vuepress site for a deployment.
To version the current next document version found in the ./docs folder, run the following command
npx vuepress version docs ${VERSION}Example: npx vuepress version docs 1.0.1.
This will preserve the documents found in ./docs to ./website/versioned_docs/1.0.1.
This is managed by a vuepress versioning plugin.
The latest version will automatically be loaded when access the website, with a version drop-down list appearing on the top left (next to the Mojaloop logo). Here you can select the different versions that have been archived in the ./vuepress/website/versioned_docs/ folder, with next representing the working folder ./docs.
We deploy these docs automatically with CircleCI upon merges to the master branch.
Go to: https://docs.mojaloop.io/mojaloop-business-docs/ to see the live site!
The deploy script does not currently take versioning into account, but will in the future.
Note: for this to work, we have temporarily disabled the "only build pull requests" setting on Circleci Someone please remember to turn that back on!
You can also deploy them manually, by running:
sh ./scripts/.publish-gh-pages.shApache License. Version 2.0
See ./license for more information.