Mojaloop Docs 2.0 Contributing Guide
Last updated
Was this helpful?
Last updated
Was this helpful?
This README contains guide on contributing to Mojaloop Docs 2.0 - a Vuepress-powered site for Mojaloop documentation.
The first step in contributing to the Mojaloop documentation repository is to go through the Contributors guide and the
Refer to the for guide on how to setup the documentation site locally.
New content added to the documentation should follow the guidelines defined here in additi
TBD
While much of the migration is done manually for now, a script will soon be provided to allow you move content from an existing directory to the new documentation site.
TBDD
These are some of the defined conventions that guide contributing to the
All top-level documentation pages should be created as folders in the vuepress/docs
directory. e.g. a Community
top-level page is created in vuepress/docs/community/
All
Assets including images for a specific pages should be added to the /assets/
directory for that page/
The naming convention for images (new or existing) added to the /assets
documentation name should be `<page_name>-
As much as is possible, the following should be adhered to when creating headers for pages and sections:
Page headers should use sentence case.
Page headers and section headers should not contain numbers. The previous Mojaloop documentation used numbers as part of page and section headers which resulted in brittle links that were easily broken when content was changed.
Once you have created content that you are ready, the following steps should be followed to create a new PR:
Check for any typographical errors
Create a pull request using master
as the base branch
Before opening a PR, ensure that all the links on the new page are correct and accessible. While this process is manual for now, a ./verify-links
script will soon be added to the repository that can be run to verify all the links of the page.
TBD
Run the ./verify-links
script to ensure that there are no broken links on your page. See section for more details.