Skip to content

Latest commit

 

History

History
162 lines (109 loc) · 5.17 KB

CONTRIBUTING.md

File metadata and controls

162 lines (109 loc) · 5.17 KB

Contributor's Guide

Welcome to the Gnosis Documentation site! We welcome all contributors.

Environments

Prod: https://docs.gnosischain.com Dev: https://docs.dev.gnosisdev.com/

Git Workflow

Currently, @zengzengzenghuy and @giacomolicari have push rights to release branch.

Run the project

Prerequisites

Node.js version 16.14 or higher.

Installation

$ nvm use
$ yarn install

Local Development

$ 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.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Contents

  • 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.

Submit an Issue

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

Creating Pull Requests

For help, see GitHub Docs: Linking a pull request to an issue using a keyword.

  • Submit a PR against the dev branch of the gnosischain/documentation repo
  • Follow the PR template instructions carefuly

Create a release

Currently only @zengzengzenghuy and @giacomolicari has the right to create a new release.
To create a new release

  1. Switch to release branch, click on text showing "N commit(s) behind of main", and click 'Create pull request'.
  2. Create a new PR, ensure that all Actions in PR are passed, then you may continue to create a new release.
  3. Navigate to and click Releases on right sidebar (Under About section), you should be able to see releases history under https://github.com/gnosischain/documentation/releases.
  4. Click 'Draft a new release'
  • click 'Choose a tag' and create a new target (please refer to the naming rule for releases, i.e. v0.8.x)
  • Target: dev
  • Release title: same as release tag, i.e. v0.8.x
  • Click 'Generate release notes', this will automatically generate notes for current release.
  • Tick the box showing 'Set as the latest release'
  1. Click 'Publish release', and wait for all the actions passed.
  2. Congrats, you just created a new release for gnosis documentation!

Writing style

We selected a collection of best practices from the industry to make the website easy to read, global, diverse and searchable

Transfering Gitbook Pages

When transfering documents from the old gitbook, consider the funcionality difference detailed below, and the following:

  • Relevance and validity of the content
  • xdaichain was renamed to gnosis
  • Open Ethereum was deprecated
  • Nifty Wallet deprecation
  • Internal and external links

Static Assets

/static
    /files
    /img
        # By Docs folders
        /about
        /bridges
        /developers
        /node

Gitbook

/.gitbook/assets/

Docusaurus

/static/img/

Alerts

Gitbook

{% hint style="info" %}
Message
{% endhint %}

Docusaurus

:::info
Message
:::

Refer to docusaurus docs for more admonition types.

Tabs

Refer to docusaurus docs for details on tabs.

Useful Tools