Developer Portal contains technical documentation for all things Rarimo. This website is built using Docusaurus 2, a modern static website generator
yarnyarn startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
yarn typecheck
yarn lintThis does a quick typecheck / lint. We don't have any formal tests (yet) for this repo.
yarn buildThis command generates static content into the build directory and can be served using any static contents hosting service.
The Divio Documentation System principles were adopted to keep the docs comprehensive and manageable. In a nutshell, every document falls into one of the four categories:
- High-level explanation docs;
- Tutorials(learning-oriented guides);
- How-to-guides(problem-oriented guides);
- Reference;
Documents in each category have a different purpose and require a different approach to writing them.
We welcome contributions from the community! To contribute to this project, follow these steps:
- Fork the repository.
- Create a new branch with a descriptive name for your feature or bug fix.
- Make your changes and commit them.
- Push your changes to your branch on your GitHub fork.
- Create a pull request from your branch to the
mainbranch of this repository.
Please ensure your pull request adheres to the following guidelines:
- Add a clear pull request title;
- Add a comprehensive pull request description that includes the motivation behind the changes, steps needed to test them, etc;
- Update the CHANGELOG.md accordingly;
- Keep the codebase clean and well-documented;
- Make sure your code is properly tested;
- Reference any related issues in your pull request;
The maintainers will review your pull request and may request changes or provide feedback before merging. We appreciate your contributions!
For the changelog, see CHANGELOG.md.
This project is under the MIT License - see the LICENSE file for details.