Tweeddalex setup help

.gitbook.yaml

@@ -0,0 +1,5 @@
+root: ./
+
+structure:  
+    readme: README.md  
+    summary: SUMMARY.md

CODE_OF_CONDUCT.md

@@ -8,26 +8,26 @@ We pledge to act and interact in ways that contribute to an open, welcoming, div
 
 ## Our Standards
 
-Examples of behavior that contributes to a positive environment for our community include:
+Examples of behaviour that contributes to a positive environment for our community include:
 
 * Demonstrating empathy and kindness toward other people
 * Being respectful of differing opinions, viewpoints, and experiences
 * Giving and gracefully accepting constructive feedback
 * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
 * Focusing on what is best not just for us as individuals, but for the overall community
 
-Examples of unacceptable behavior include:
+Examples of unacceptable behaviour include:
 
 * The use of sexualized language or imagery, and sexual attention or advances of any kind
-* Use of inappropriate or non-inclusive language or other behavior deemed unprofessional or unwelcome in the community
+* Use of inappropriate or non-inclusive language or other behaviour deemed unprofessional or unwelcome in the community
 * Trolling, insulting or derogatory comments, and personal or political attacks
 * Public or private harassment
 * Publishing others' private information, such as a physical or email address, without their explicit permission
 * Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Enforcement Responsibilities
 
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behaviour and will take appropriate and fair corrective action in response to any behaviour that they deem inappropriate, threatening, offensive, or harmful.
 
 Community leaders have the right and responsibility to remove, edit, or reject comments, commits, messages, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
 
@@ -37,7 +37,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported to the community leaders responsible for enforcement at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 
@@ -47,28 +47,28 @@ Community leaders will follow these Community Impact Guidelines in determining t
 
 ### 1. Correction
 
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+**Community Impact**: Use of inappropriate language or other behaviour deemed unprofessional or unwelcome in the community.
 
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behaviour was inappropriate. A public apology may be requested.
 
 ### 2. Warning
 
 **Community Impact**: A violation through a single incident or series of actions. Any Community Impact assessment should take into account:
 
 1. The severity and/or number of incidents/actions
-2. Non-compliance with previous private warnings from community leaders \(if applicable\)
+2. Non-compliance with previous private warnings from community leaders (if applicable)
 
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+**Consequence**: A warning with consequences for continued behaviour. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
 
 ### 3. Temporary Ban
 
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behaviour.
 
 **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
 
 ### 4. Permanent Ban
 
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behaviour, harassment of an individual, or aggression toward or disparagement of classes of individuals.
 
 **Consequence**: A permanent ban from any sort of public interaction within the community.
 
@@ -79,4 +79,3 @@ This Code of Conduct is adapted from the [Contributor Covenant](https://www.cont
 Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
 
 For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).
-

LICENSE

@@ -175,8 +175,7 @@
 
    END OF TERMS AND CONDITIONS
 
-
-   Copyright 2021 Lab309 Ltd (doing business as "cheqd")
+   Copyright 2021 Cheqd Foundation Limited (doing business as "cheqd")
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

NOTICE.md

@@ -1,11 +1,10 @@
 ---
 description: >-
-  This is the NOTICE file as described under the Apache License 2.0 terms for
-  inclusion in downstream software projects that use this code.
+  This is the NOTICE file as described under the Apache License 2.0 terms for inclusion in downstream software projects that use this code.
 ---
 
 # Notice
 
-`cheqd-node` Copyright 2021 Lab309 Ltd
+Copyright 2021-2022 Cheqd Foundation Limited
 
-This product includes software developed at Lab309 Ltd, doing business as "cheqd"
+This product includes software developed at Cheqd Foundation Limited, doing business as "cheqd"

README.md

@@ -1,76 +1,83 @@
 # cheqd: Node Documentation
 
-**cheqd** is a purpose-built network for decentralised identity.
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/cheqd/cheqd-node/Test/main?style=flat-square)
 
-`cheqd-node` is the server/node portion of the cheqd network stack, built using [Cosmos SDK](https://github.com/cosmos/cosmos-sdk) and [Tendermint](https://github.com/tendermint/tendermint).
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/cheqd/cheqd-node?color=green&label=stable+version&style=flat-square) ![GitHub Release Date](https://img.shields.io/github/release-date/cheqd/cheqd-node?style=flat-square)
 
-## Quick start for joining cheqd networks
+![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/cheqd/cheqd-node?include_prereleases&label=pre-release&style=flat-square) ![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/cheqd/cheqd-node/latest?style=flat-square)
 
-Join our [**cheqd Community Slack**](http://cheqd.link/join-cheqd-slack) for help, question, and support if you are looking at joining either the cheqd mainnet or the testnet/ Either the cheqd team, or one of your fellow node operators will be happy to offer some guidance.
+![GitHub contributors](https://img.shields.io/github/contributors/cheqd/cheqd-node?style=flat-square) ![GitHub repo size](https://img.shields.io/github/repo-size/cheqd/cheqd-node?style=flat-square)
 
-### Mainnet
+## ℹ️ Overview
 
-Getting started as a node operator on the cheqd network mainnet requires the following steps:
+[**cheqd**](https://www.cheqd.io) is a public self-sovereign identity (SSI) network for building secure 🔐 and private 🤫 self-sovereign identity systems on [Cosmos](https://cosmos.network) 💫. Our core vision is to add viable commercial models to decentralised digital 🆔
 
-1. [Install the `cheqd-node` software](docs/setup-and-configure/README.md) (**version 0.3.1+**) on a hosting platform of your choice.
-name/moniker that is set for your mainnet node)
-2. Once you have acquired CHEQ tokens, [promote your node to a validator](docs/setup-and-configure/configure-new-validator.md).
-3. If successfully configured, your node would become the latest validator on the cheqd mainnet!
+`cheqd-node` is the ledger/node component of the cheqd network tech stack, built using [Cosmos SDK](https://github.com/cosmos/cosmos-sdk) and [Tendermint](https://github.com/tendermint/tendermint).
 
-### Testnet
+## ▶️ Quick start for joining cheqd networks
 
-Joining the cheqd testnet is very similar to the instructions above for mainnet, with a few key differences:
+Join our [**cheqd Community Slack**](http://cheqd.link/join-cheqd-slack) for help, questions, and support if you are looking to join our [mainnet](https://explorer.cheqd.io) or the [testnet](https://testnet-explorer.cheqd.io/).
 
-1. Install [v0.4.0 of cheqd-node](https://github.com/cheqd/cheqd-node/releases/tag/v0.4.0) (instead of v0.3.1+)
-2. Fill our [testnet node operator onboarding form](http://cheqd.link/join-testnet-form) with the same details as above.
+Either the cheqd team, or one of your fellow node operators will be happy to offer some guidance.
 
-## Usage
+### ✅ Mainnet
+
+Getting started as a node operator on the cheqd network [mainnet](https://explorer.cheqd.io) is as simple as...
+
+1. [Install the `cheqd-node` software](docs/setup-and-configure/README.md) (**version 0.4.0+**) on a hosting platform of your choice
+2. Once you have acquired CHEQ tokens, [promote your node to a validator](docs/validator-guide/README.md)
+
+If successfully configured, your node would become the latest validator on the cheqd mainnet. Welcome to the new digital ID revolution!
+
+### 🚧 Testnet
+
+Our [testnet](https://testnet-explorer.cheqd.io/) is the easiest place for developers and node operators to get started if you're not *quite* ready yet to dive into building apps on our mainnet. To get started...
+
+1. Install [v0.4.0 of cheqd-node](https://github.com/cheqd/cheqd-node/releases/tag/v0.4.0) (same version as that on mainnet)
+2. Acquire testnet CHEQ tokens through [our testnet faucet](https://testnet-faucet.cheqd.io).
+
+## 🧑‍💻 Using cheqd
 
 Once installed, `cheqd-node` can be controlled using the [cheqd Cosmos CLI guide](docs/cheqd-cli/README.md).
 
-### Currently supported functionality
+### 📌 Currently supported functionality
 
 * Basic token functionality for holding and transferring tokens to other accounts on the same network
 * Creating, managing, and configuring accounts and keys on a cheqd node
 * Staking and participating in public-permissionless governance
 * Governance framework for public-permissionless self-sovereign identity networks
-* Creating [`did:cheqd` method DIDs](architecture/adr-list/adr-002-cheqd-did-method.md), DID Documents ("DIDDocs), and querying full DIDDocs
+* Creating [`did:cheqd` method DIDs](architecture/adr-list/adr-002-cheqd-did-method.md), DID Documents ("DIDDocs"), and querying full DIDDocs
 
-### Upcoming functionality
+### 🔮 Upcoming functionality
 
-A non-exhaustive list of future planned functionality \(not necessarily in order of priority\) is highlighted below:
+A non-exhaustive list of future planned functionality (not necessarily in order of priority) is highlighted below:
 
 * Creating and managing Verifiable Credentials anchored to DIDs on cheqd mainnet
 * Querying DIDDoc fragments and specific resources
-* Defining Schemas and Credential Definitions
+* Defining persistent Schemas that can be referenced using DIDs
 
-We plan on adding new functionality rapidly and on a regular basis. We will be sharing regular updates through our **Live Product Updates** page which includes our product roadmap, release notes, node operator FAQs and more. We welcome feedback on our [cheqd Community Slack](http://cheqd.link/join-cheqd-slack) workspace.
+We plan on adding new functionality rapidly and on a regular basis and welcome feedback on our [cheqd Community Slack](http://cheqd.link/join-cheqd-slack) workspace.
 
-## Building from source
+## 🛠 Developing & contributing to cheqd
 
-`cheqd-node` is created with [Starport](https://github.com/tendermint/starport). If you want to build a node from source or contribute to the code, please read our guide to [building and testing](docs/build-and-networks/README.md).
+`cheqd-node` is written in Go and built using Cosmos SDK. The [Cosmos SDK Developer Guide](https://docs.cosmos.network/) explains a lot of the [basic concepts](https://docs.cosmos.network/v0.44/basics/app-anatomy.html) of how the cheqd network functions.
+
+If you want to build a node from source or contribute to the code, please read our guide to [building and testing](docs/build-and-networks/README.md).
 
 ### Creating a local network
 
 If you are building from source, or otherwise interested in running a local network, we have [instructions on how to set up a new network](docs/setup-and-configure/README.md) for development purposes.
 
-## Community
-
-The [**cheqd Community Slack**](http://cheqd.link/join-cheqd-slack) is our chat channel for the open-source community, software developers, and node operators.
-
-Please reach out to us there for discussions, help, and feedback on the project.
-
-## Bug Reporting & New Feature Requests
+## 🐞 Bug reports & 🤔 feature requests
 
-If you notice anything not behaving how you expected, or would like to make a suggestion / request for a new feature, please submit a **bug_report** or **feature_request**  by creating a [**New Issue**](https://github.com/cheqd/cheqd-node/issues/new/choose) and selecting the relevant template.
+If you notice anything not behaving how you expected, or would like to make a suggestion / request for a new feature, please create a [**new issue**](https://github.com/cheqd/cheqd-node/issues/new/choose) and let us know.
 
+## 💬 Community
 
-### Social media
+The [**cheqd Community Slack**](http://cheqd.link/join-cheqd-slack) is our primary chat channel for the open-source community, software developers, and node operators.
 
-Follow the cheqd team on our social channels for news, announcements, and discussions.
+Please reach out to us there for discussions, help, and feedback on the project.
 
-* [@cheqd\_io](https://twitter.com/cheqd_io) on Twitter
-* [@cheqd](https://t.me/cheqd) on Telegram \(with a separate [announcements-only channel](https://t.me/cheqd_announcements)\)
-* [Medium](https://blog.cheqd.io/) blog
-* [LinkedIn](http://cheqd.link/linkedin)
+## 🙋 Find us elsewhere
 
+[![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white)](https://t.me/cheqd) [![Discord](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white)](http://cheqd.link/discord-github) [![Twitter](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/intent/follow?screen_name=cheqd_io) [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](http://cheqd.link/linkedin) [![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](http://cheqd.link/join-cheqd-slack) [![Medium](https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white)](https://blog.cheqd.io) [![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/channel/UCBUGvvH6t3BAYo5u41hJPzw/)

SECURITY.md

@@ -8,5 +8,5 @@ We take all security bugs seriously. If confirmed upon investigation, we will pa
 
 There are two ways to report a security bug:
 
-* Email us at [securitycheqd.io](mailto:[email protected])
-* Join [our cheqd Community Slack](http://cheqd.link/join-cheqd-slack) and post a message on the \#security channel
+* Email us at [security-github@cheqd.io](mailto:security-github@cheqd.io)
+* Join [our cheqd Community Slack](http://cheqd.link/join-cheqd-slack) and post a message on the #security channel

SUMMARY.md

@@ -12,9 +12,10 @@
     * [Upgrading a cheqd node using Debian package releases](docs/setup-and-configure/debian/deb-package-upgrade.md)
   * [Installing cheqd-node with Docker](docs/setup-and-configure/docker-install.md)
   * [Installing a cheqd node from binary package releases](docs/setup-and-configure/binary-install.md)
-  * [Configure a cheqd node as validator](docs/setup-and-configure/configure-new-validator.md)
+* [Setting up and configuring validators](docs/validator-guide/README.md)
+  * [FAQs for validator operators](docs/validator-guide/validator-faq.md)
 * [cheqd Cosmos CLI](docs/cheqd-cli/README.md)
-  * [cheqd Command Line Interface \(CLI\) guide](docs/cheqd-cli/README.md)
+  * [cheqd Command Line Interface (CLI) guide](docs/cheqd-cli/README.md)
   * [Using cheqd Cosmos CLI to manage keys](docs/cheqd-cli/cheqd-cli-key-management.md)
   * [Using cheqd Cosmos CLI to manage accounts](docs/cheqd-cli/cheqd-cli-accounts.md)
   * [Using cheqd Cosmos CLI to manage a node](docs/cheqd-cli/cheqd-cli-node-management.md)
@@ -31,11 +32,11 @@
 
 ## Architecture
 
-* [Architecture Decision Record \(ADR\) Process](architecture/README.md)
+* [Architecture Decision Record (ADR) Process](architecture/README.md)
 * [List of ADRs](architecture/adr-list/README.md)
   * [ADR 001: Payment mechanism for issuing credentials](architecture/adr-list/adr-001-payment-mechanism-for-issuing-credentials.md)
   * [ADR 002: cheqd DID method, identity entities, and transactions](architecture/adr-list/adr-002-cheqd-did-method.md)
-  * [ADR 003: Command Line Interface \(CLI\) tools](architecture/adr-list/adr-003-cli-tools.md)
+  * [ADR 003: Command Line Interface (CLI) tools](architecture/adr-list/adr-003-cli-tools.md)
   * [ADR 004: Token fractions](architecture/adr-list/adr-004-token-fractions.md)
   * [ADR 005: Genesis parameters](architecture/adr-list/adr-005-genesis-parameters.md)
   * [ADR 006: Community tax](architecture/adr-list/adr-006-community-tax.md)