Ronin documentation

This repository contains Ronin documentation deployed at docs.roninchain.com. The documentation is built with Docusaurus, a static site generator.

Local development

To preview changes as you edit the files, you can run a local development server that serves the Ronin documentation site and reflects the latest changes.

Prerequisites

Install the dependencies:

• Node.js version 16.14 or higher: https://nodejs.org/en/download
• Yarn: https://classic.yarnpkg.com/lang/en/docs/install/
• Vale: https://vale.sh/docs/vale-cli/installation/

Steps

1. Clone this repository to create its copy on your local computer.

2. Navigate to the ronin-documentation directory:

   cd ronin-documentation
   

3. Install the project:

   yarn install
   

4. Start the local server:

   yarn start
   

By default, a browser window opens at http://localhost:3000.

Contribute

For instructions on how to get started with our project, see the Contribution guide.

Deploy

Ronin documentation deployments are automated. When a PR is merged to the main branch, it's automatically deployed to production and the status is displayed on the PR's page in GitHub.

License

This project is licensed under the terms of the GNU General Public License v3.0 license.