ggxchain / documentation Goto Github PK

Document how to use GGx's DEX platform.

The project has progressed significantly, so the first page of the docs needs to be updated.

Description
We want to have WASM basic concepts description in Golden Gate documentation

Definition of Done
WASM documentation describes basic concepts of WASM
Documentation passes grammarly review

Suggested solution
Markdown file

Description
We want to have Golden Gate accounts concept documented

Definition of Done
Accounts documentation describes basic concepts of accounts in Golden Gate
Documentation passes grammarly review

Suggested solution
Markdown file

Description
We want to have a maintenance guide for validators

Definition of Done
Maintenance guide contains ejection instructions
Maintenance guide contains planned downtime instructions
Maintenance guide contains upgrading instructions
Maintenance guide contains monitoring instructions
Maintenance guide reviewed through grammarly pro

Suggested solution
Markdown file

Description

We want to have SPREE concept documented

Definition of Done

SPREE documentation describes basic concepts of SPREE
Documentation passes grammarly review.

Description
We want to have how to guide for solidity contracts

Definition of Done
Developer can deploy a contract using how to guide
Developer can execute WASM calls from the EVM environment using how to guide
How to guide passes grammarly review

Suggested solution
Markdown file

Description

We want to have glossary terms for the validators guide.

Definition of Done

Modify the glossary so it contains:

• Glossary contains description of basic terms for running a validator in the blockchain network (e.g. Staking)
• Glossary contains description of terms specific to running a validator in Golden Gate network (e.g. Golden Gate Stash account)
• Glossary contains description of primary architecture pieces required for the Validator (e.g. NTP, VPS)
• Glossary reviewed through grammarly pro

Description

We want to have a configuration guide for validators.

Definition of Done

Configuration guide contains security configuration instructions with risks explanation
Configuration guide contains key management requirements
Configuration guide contains availability requirements
Configuration guide reviewed through grammarly pro

Description
We want to have a staking guide for validators

Definition of Done
Staking guide contains high level description of consensus economic incentives used in Golden Gate
Staking guide contains payouts description formulas and algorithms
Staking guide contains staking instructions.
Staking guide reviewed through grammarly pro

Suggested solution
Markdown file

Description:

As most developers, validators and other participants maybe familiar with Substrate docs, it would be good to use the same framework and layout as in Substrate docs, with some difference in colors, etc.

Definition of done:

• A working version with a nice look and feel, dark and light modes, capable of reading .md files.
• Move existing .md files and structure to the new UI
• Set up the deployment process

Description

We want to have a glossary for documentation.

Definition of Done

Provide a Markdown file that contains:

• a description of basic terms used in Golden Gate
• anchor links between terms

The glossary must use proper grammar.

Description
We want to have an installation guide for validators

Definition of Done
Installation guide contains OS software requirements. Installation guide tested on listed OS software
Installation guide contains hardware requirements. Installation guide tested on listed hardware
Installation guide contains required applications installation instructions.
Installation guide reviewed through grammarly pro

Suggested solution
Markdown file

Description

We need to outline our documentation.

Definition of Done

Provide an outline of our documentation as well as a command to compile a gitbook for local review.

Description

We want to have wallets guide.

Definition of Done

Provide a markdown file with instructions for:

• Developer can use tokens for WASM deployments using wallets guide
• Developer can use tokens for EVM deployments using wallets guide
• Wallets guide passes grammarly review
• Link to SUMMARY.md

Description
We want to have Golden Gate extrinsics documented

Definition of Done
Extrinsics documentation describes basic concepts of pallets and extrinsics in Golden Gate
Documentation passes grammarly review

Suggested solution
Markdown file

Description
We want to have how to guide for WASMcontracts

Definition of Done
Developer can deploy a contract using how to guide
How to guide passes grammarly review

Suggested solution
Markdown file