dubrado / quais-docs

Quai Network Documentation

Thanks for your interest in contributing to the Quai Network documentation! This document contains information on how this repository is managed, and how to contribute to the documentation.

Table of Contents

• Who Owns This Repo?
• Docs Architecture
• MDX
• Images
• Local Development
• How To Contribute

Who Owns This Repo?

This repository is owned by Dominant Strategies, a software development company working on Quai Network. All changes to this repository must be approved by the Dominant Strategies team before being merged into the main branch.

For help contributing to this repository or to discuss proposed changes, you can join and chat in the Quai Dev Discord Server.

Docs Architecture

This documentation runs off of the Mintlify Framework.

The Quai documentation is divided into five seperate tabs: Learn, Build, SDK, Client, and Guides. Each of the tabs contain a series of .mdx docs that are displayed in the sidebar of the documentation.

Tab	Description
Learn	General information about Quai Network, including an overview of the network architecture and its features
Build	Information on how to build on Quai Network, including smart contract deployment, APIs, and libraries
SDK	Information on the quais.js SDK, including how to use it and its features
Client	A broad overview of the go-quai client, stratum proxy, and GPU miner.
Guides	Guides on how to run the client, develop, and more

Most contributions to this repository will not require the creation of a new doc, and will focus on editing existing docs; however, if your proposed changes do require a new doc, you can learn how to create one in the Mintlify documentation. While there are no strict guidelines for the organization of docs within tabs, proposed changes should follow the existing docs structure as closely as possible.

MDX

Each doc is created in Markdown as an .mdx file. .mdx files allow for the use of components in your Markdown docs. You can learn more about the full capabilities of .mdx files in the mdxjs documentation.

Images

Images live in the /images/ folder of this repository. To add a new image, add the file to the /images/ folder and reference it in your Markdown doc(s) with the following: ![AltText](imagepath) or <img src="imagepath" alt="image title />

Local Development

Install the Mintlify CLI to preview the documentation changes locally. To install, use the following command

npm i -g mintlify

Run the following command at the root of the documentation (where mint.json is)

mintlify dev

How To Contribute

The Quai Network docs are built using the Mintlify Framework and written using MDX.

To contribute to the Quai documentation, you'll need to fork the repository, commit your changes to your fork, and create an upstream pull request with your changes. This will allow for open-sourced, collaborative review of all changes before they are merged into the main branch.

In the effort of maintaining the quality and integrity of the Quai Network documentation, all changes require:

• DS Team approval: All changes to this repository must be approved by the Dominant Strategies team before being merged into the main branch.
• Passing CI: All changes must pass the CI checks before being merged into the main branch.
• Conversation: Reach out to the DS team directly on the Quai Dev Discord Server to discuss your proposed changes.

Alternate language support is currently under development. If you'd like to help us translate the Quai Network documentation, please reach out to our team via the Discord link above.