Welcome to the Basepair Docs repository! This repository hosts the documentation for the Basepair platform, built using the Docusaurus framework.
The documentation provides solution pages, feature descriptions, and comprehensive guides for users of the Basepair platform.
Ensure you have the following installed before proceeding:
Node.js (>= 14.x) Yarn (>= 1.22.x)
To install the required dependencies, run the following command:
$ yarn
To start a local development server:
$ yarn start
This will:
- Launch a local development server.
- Open a browser window with the documentation site.
- Automatically reflect most changes live without restarting the server.
- Branch Creation
- Create a new branch from the dev branch for your changes.
- Implement Changes
- Make the necessary updates or additions.
- Commit and Push
- Commit your changes and push the branch to the repository.
- Pull Request
- Open a pull request to merge your changes into the dev branch. Ensure the pull request includes a clear description of the changes.