Introduction

Rahat documentation website is mainly focused on the technical information of Rahat.The site comprises contents like: Getting started, Code of Conduct, Contributing Guidelines, API Documentation, User Gudie and many more. You can visit https://docs.rahat.io to know Rahat technically.

This is a documentation website of Rahat which is built using Docusaurus 2, a modern static website generator.

Installation

To setup this website on your machine locally, first clone this repository to your local machine and create a folder named 'config' on root of this repository and add local.json file.

1. Install the required depedencies $ yarn

2. Start the server $ yarn start

   This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

3. Build $ yarn build

   This command generates static content into the build directory and can be served using any static contents hosting service.

Coding Styles

This repository uses eslint to enforce air-bnb coding styles.

Contributing

Everyone is very welcome to contribute on the codebase of Rahat. Please reach us in Discord in case of any query/feedback/suggestion.

For more information on the contributing procedure, see Contribution.