Idea about a $DAG wiki

General
18
title description author discussions-to status type category created requires
$DAG Wiki Creation of a wiki which defines and explain all the HGTP terms, concepts and details Serg HIP-1 HGTP Governance - #10 by Serg Draft Informational N/A 2023-02-16 N/A

Abstract

This proposal aims to create a wiki for HGTP and its ecosystem. This wiki will define all the terms and concepts related to HGTP and $DAG. It will also include relevant information about current network configuration (ie. rewards distribution, snapshots size, etc.).

Motivation

Currently there is a lot of information spread across several documents, webpages, tweets, telegram groups, medium articles… so it is difficult to find some specific information and to have a complete overview of HGTP scope and details.

Specification

  • The wiki may be implemented in the Constellation doc hub.
  • The wiki shall be maintained by both community and Constellation Network. Community can create wiki articles or propose modifications to existing articles but Constellation Network must review and approve all the community inputs before they are publicly published in order to ensure accuracy of the information. It means community members may have and editor role but Constellation Network must approve on its validator role and it cannot be delegated.
  • Constellation Network must also create new entries and/or complemented community proposals.
  • The wiki must have definitions to all the terms, using layman language when possible, to ensure that any person speaking about the HGTP ecosystem has the same understanding on the topics when they are discussed in any channel.
  • The wiki must include network configuration so it will not be needed to be checked in the code existing in GitHub. This includes token minting information, snapshots information, PRO score criteria, etc.
  • The community members who feed the wiki may be rewarded.
  • Community inputs by Constellation Network should not take longer than 1 week.
  • The wiki must include a search functionality and alphabetical sorting.
  • Community must be able to request to include new terms or explanations which may be implemented either by other community members or directly by Constellation Network.
  • There may be state channels representatives who must only validate entries specifically related to a concrete state channel.

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119 and RFC 8174.

Rationale

Constellation Network shall be the last responsible of the content of the wiki in order to ensure accuracy of the information. Community shall collaborate and request information which can be considered relevant. Constellation Network shall provide information which is difficult to get/explain by any community member.

Backwards Compatibility

No backward compatibility issues found.

Test Cases

N/A

Reference Implementation

N/A

Security Considerations

A role based access rights shall exist to ensure only Constellation Network can validated and publish information to mitigate the risk of a malicious actor can use the wiki for misinformation or to harm HGTP and its ecosystem.

Copyright

Copyright and related rights Serg 2023.