Thank you for your interest in contributing!
Node.js version 14.13 or higher.
$ yarn install
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
- Docs are located in the docs directory.
- Landing pages are located in the src/pages directory.
- Images and static files are located in the static directory.
- The left side-bar of the page is controlled by sidebars.js.
- Docusaurus complete documentation can be found here.
Start by searching if an issue already exists. If a related issue doesn't exist, you can open a new issue following the instructions of the template accordingly.
Issues are categorized by type:
- Feature
- Content
- Bug
For help, see GitHub Docs: Linking a pull request to an issue using a keyword.
- Submit a PR against the
mainbranch of thegnosischain/documentationrepo - Follow the PR template instructions carefuly
We selected a collection of best practices from the industry to make the website easy to read, global, diverse and searchable
- General Writing Guidelines (by OpenStack)
- Bias-free communication (by Microsoft)
- Global communications (by Microsoft)
When transfering documents from the old gitbook, consider the funcionality difference detailed below, and the following:
- Relevance and validity of the content
xdaichainwas renamed tognosis- Open Ethereum was deprecated
- Nifty Wallet deprecation
- Internal and external links
/.gitbook/assets/
/static/img/
{% hint style="info" %}
Message
{% endhint %}
:::info
Message
:::
Refer to docusaurus docs for more admonition types.
{% file src="somepath/somefile.zip" %}
{@file: /somefile.zip}
Place files in /static/files/
{% embed url="https://www.youtube.com/watch?v=yPYYKz0u9K0t=10s" %}
{@youtube: yPYYKz0u9K0t,start=10}
Refer to docusaurus docs for details on tabs.