Chirp Token Documentation

Welcome to the Chirp Token Documentation repository!

Local Development

To set up the development environment and preview the documentation locally, follow these steps:

Prerequisites

• Node.js and npm installed on your system. You can download and install them from here.
• Yarn package manager. Install it globally via npm by running:

  npm install -g yarn

Installation

1. Clone this repository to your local machine:

   git clone [email protected]:chirpwireless/docs.chirptoken.io.git

2. Navigate to the project directory:

   cd docs.chirptoken.io

3. Install the dependencies using Yarn:

   yarn install

Local Development Server

Once the installation is complete, you can start the local development server to preview the documentation:

yarn start

This command starts a development server and opens the documentation site in your default web browser. Any changes you make to the documentation files will be automatically reflected in the browser.

Contributing

We welcome contributions from the community to improve and expand our documentation. If you find any issues, errors, or have suggestions for improvement, please don't hesitate to open an issue or pull request in this repository.

How to Contribute

1. Fork the repository.
2. Make your changes in a new branch.
3. Submit a pull request with a clear description of your changes.
4. Your pull request will be reviewed by our team, and we'll work with you to get it merged.

Contact Us

If you have any questions, feedback, or need support, feel free to contact us or open an issue in this repository. We're here to help!

Thank you for choosing Chirp Token!