Rename docs, adjust for GitBook

JoinColony · Jun 23, 2022 · 0fb311b · 0fb311b
1 parent 08a99d3
commit 0fb311b
Show file tree

Hide file tree

Showing 60 changed files with 399 additions and 276 deletions.
diff --git a/.gitbook.yaml b/.gitbook.yaml
@@ -0,0 +1,4 @@
+root: ./docs
+
+structure:  
+    readme: INDEX.md  
diff --git a/docs/CODE_OF_CONDUCT.md → .github/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md → .github/CODE_OF_CONDUCT.md
diff --git a/docs/CONTRIBUTING.md → .github/CONTRIBUTING.md b/docs/CONTRIBUTING.md → .github/CONTRIBUTING.md
diff --git a/docs/ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE.md b/docs/ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE.md
diff --git a/docs/PULL_REQUEST_TEMPLATE.md → .github/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md → .github/PULL_REQUEST_TEMPLATE.md
diff --git a/docs/README.md → .github/README.md b/docs/README.md → .github/README.md
diff --git a/docs/templates/_Interface_CoinMachine.md → docs/.templates/coinmachine.md b/docs/templates/_Interface_CoinMachine.md → docs/.templates/coinmachine.md
diff --git a/docs/.templates/icolony.md b/docs/.templates/icolony.md
@@ -0,0 +1 @@
+# Colony (`IColony`)
diff --git a/docs/.templates/icolonynetwork.md b/docs/.templates/icolonynetwork.md
@@ -0,0 +1 @@
+# Colony Network (`IColonyNetwork`)
diff --git a/docs/.templates/ietherrouter.md b/docs/.templates/ietherrouter.md
@@ -0,0 +1 @@
+# Ether Router (`IEtherRouter`)
diff --git a/docs/.templates/imetacolony.md b/docs/.templates/imetacolony.md
@@ -0,0 +1 @@
+# Meta Colony (`IMetaColony`)
diff --git a/docs/.templates/irecovery.md b/docs/.templates/irecovery.md
@@ -0,0 +1 @@
+# Recovery (`IRecovery`)
diff --git a/docs/.templates/ireputationminingcycle.md b/docs/.templates/ireputationminingcycle.md
@@ -0,0 +1 @@
+# Reputation Mining Cycle (`IReputationMiningCycle`)
diff --git a/docs/.templates/itokenlocking.md b/docs/.templates/itokenlocking.md
@@ -0,0 +1 @@
+# Token Locking (`ITokenLocking`)
diff --git a/docs/templates/_Interface_OneTxPayment.md → docs/.templates/onetxpayment.md b/docs/templates/_Interface_OneTxPayment.md → docs/.templates/onetxpayment.md
diff --git a/.../templates/_Interface_VotingReputation.md → docs/.templates/votingreputation.md b/.../templates/_Interface_VotingReputation.md → docs/.templates/votingreputation.md
diff --git a/docs/templates/_Interface_Whitelist.md → docs/.templates/whitelist.md b/docs/templates/_Interface_Whitelist.md → docs/.templates/whitelist.md
diff --git a/docs/INDEX.md b/docs/INDEX.md
@@ -0,0 +1,19 @@
+---
+cover: >-
+  https://rawcdn.githack.com/JoinColony/colonyNetwork/869c7d8233dcb1314b5fd3606e688ce8107d1c3c/docs/img/colonyNetwork_color.svg
+coverY: 0
+---
+
+# Welcome!
+
+## Colony Network Documentation
+
+Welcome to the documentation for the contracts running the Colony Network as defined in the [Colony White Paper](https://colony.io/whitepaper.pdf).
+
+## Want to jump right in?
+
+Feeling like an eager beaver? Jump in to the quick start docs and get making your first request:
+
+{% content-ref url="quick-start.md" %}
+[quick-start.md](quick-start.md)
+{% endcontent-ref %}
diff --git a/docs/_bug_rules.md b/docs/_bug_rules.md
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -0,0 +1,5 @@
+# Contributing
+
+### :construction: Under construction :construction:
+
+Here will be some text that helps people contribute to the ColonyNetwork. How to set it up, how to run tests and more info related to the development process.
diff --git a/docs/doc.config.json b/docs/doc.config.json
diff --git a/docs/_bug_terms.md → docs/docs/bug-bounty.md b/docs/_bug_terms.md → docs/docs/bug-bounty.md
@@ -1,8 +1,68 @@
----
-title: Terms and Conditions
-section: Bug Bounty Program
-order: 1
----
+# Bug Bounty Program
+
+The Colony Network is a set of smart contracts designed to manage shared resources of multiple individuals in a secure and predictable manner. These digital assets could be of great value; it is therefore imperative that the system behaves as the Bagginses did before Bilbo: without ever doing anything unexpected.
+
+To this end, Colony is offering substantial rewards to external developers who report bugs and flaws in the colonyNetwork contracts ([terms apply](https://docs.colony.io/colonynetwork/bug-bounty-program-terms-and-conditions/)).
+
+This bug bounty does *not* apply to Colony tools such as Purser. See [Ineligible bugs](https://docs.colony.io/colonynetwork/bug-bounty-program-overview/#ineligible-bugs) for more information.
+
+## Scope
+
+This bug bounty program extends to all contracts within the [colonyNetwork Github repo](https://github.com/JoinColony/colonyNetwork).
+
+Bounties for potential bugs include, but are not limited to:
+* Reputation Mining vulnerabilities
+* Task, Domain, and Skill workflow exploits
+* Attacks during a network upgrade
+* Authority and permissions
+
+More generally, if it lives in the repository* and affects the Colony smart contracts, it's fair game.
+
+_\* There are some components of the colonyNetwork repository that are not created by the Colony team, but which still could be relevant to overall security. If a bug or exploit makes use of any external libraries or submodules, it will be considered on a case-by-case basis for elegibility._
+
+## Rules
+
+### Submission Guidelines
+
+All bugs reported must be done through the creation of an issue in the colonyNetwork github repo, or _if the submitter wishes to disclose privately, or to remain anonymous_ by an email sent to security@colony.io. Private submissions are still eligible for a bounty.
+
+Unless there is a specific reason for a private disclosure, bugs should be submitted as issues on the colonyNetwork GitHub repository, and tagged with the 'bug' label.
+
+It is requested that all submissions follow the format defined in the [issue template](https://github.com/JoinColony/colonyNetwork/blob/develop/docs/ISSUE_TEMPLATE.md) -- clarity of description and thoroughness of documentation will be a consideration for reward amount, in addition to impact and likelihood.
+
+In the case of private bug disclosure, all relevant materials should be sent in email to `security@colony.io` -- and should follow the same template as a public issue.
+
+Once submitted, the issue will be responded to, verified, accepted, and rewarded according to the timelines defined on our [service level agreement](https://docs.colony.io/colonynetwork/bug-bounty-program-terms-and-conditions/#service-level-agreement).
+
+### Submission Branches
+Participants in the program are free to submit bugs on two different branches in the colonyNetwork codebase:
+* the current testnet release (tagged on the `develop` branch) and deployed to Görli
+* against the `master` branch which will be tagged as the mainnet release for deployment
+
+### Bug Severity and Bounties
+In the same manner as the [Ethereum Bug Bounty Program](https://bounty.ethereum.org/), submissions will be evaluated by the Colony team according to the [OWASP risk rating methodology](https://www.owasp.org/index.php/OWASP_Risk_Rating_Methodology), which grades based on both _Impact_ and _Likelihood_.
+
+It is at the *sole discretion of Colony* to decide whether or not a bug report qualifies for a bounty, and to determine the severity of the issue
+
+Severity levels:
+
+* *Note*: Up to $500 USD (min. $100)
+* *Low*: Up to $2,000 USD (min. $500)
+* *Medium*: Up to $5,000 USD (min. $2,000)
+* *High*: Up to $10,000 USD (min. $5,000)
+* *Critical*: Up to $20,000 USD (min. $10,000)
+
+Issues reported may or may not constitute a security risk for the colonyNetwork contracts. A higher severity will be awarded to vulnerabilities submitted that could potentially result in either the loss of funds, or a situation in which the contracts arrive in an undesirable state that cannot be rectified through existing contract mechanisms, such as 'emergency mode' or through a network upgrade. However, all submitted bugs and vulnerabilities will be considered for prizes.
+
+### Ineligible Bugs
+
+Any vulnerabilities or flaws in other software tools created by Colony (e.g. colonyJS, purser, tailor, etc.) are not eligible. Flaws in these software tools are welcome disclosures, but will not be awarded bounties for this bug bounty program.
+
+Additional examples of ineligible bugs:
+* Attacks and vulnerabilities that depend on compromised keys or other security flaws outside the colonyNetwork codebase (keyloggers, intercepted communications, social engineering exploits, etc.).
+* Attacks that are accounted for in the system design, i.e. Ethereum network spamming, malicious reputation mining, malfeasance in colony administration.
+* Critiques of the Colony Protocol and overall mechanism design. We welcome suggestions and constructive criticism, and ask that it be directed to hello@colony.io or the [Build with Colony Forums](https://build.colony.io/)
+
 ## Eligibility and Participation Requirements
 
 To participate in this bug bounty you must:

diff --git a/docs/_Docs_Extensions.md → docs/docs/extensions.md b/docs/_Docs_Extensions.md → docs/docs/extensions.md
@@ -1,10 +1,6 @@
----
-title: Extensions
-section: Docs
-order: 6
----
+# Extensions
 
-`glider` provides the option of expanding the basic functionality of a colony through the use of _extensions_.
+Starting with `glider`, the Colony contracts provide the option of expanding the basic functionality of a colony through the use of _extensions_.
 
 Extensions are other smart contracts that have been given permissions to interact with a colony in a specified domain. Extensions can be used for many purposes, such as bundling transactions, automating certain actions, enabling stake-based permissionless functionality, or something else entirely. Their implementations are intentionally disconnected from the colonyNetwork codebase (stored in the [/contracts/extensions](https://github.com/JoinColony/colonyNetwork/tree/develop/contracts/extensions) folder in the network) to allow for greater design flexibility unbounded by the network protocol.
 

diff --git a/docs/_Docs_GetStarted.md → docs/docs/getting-started.md b/docs/_Docs_GetStarted.md → docs/docs/getting-started.md
@@ -1,16 +1,11 @@
----
-title: Get Started
-section: Docs
-order: 1
----
+# Getting started
+
 This page details how to engage purely on the contract-level, and is intended more for developers looking to contribute new features, extensions, or contract-level integrations. See our [guidelines](https://github.com/JoinColony/colonyNetwork/blob/develop/docs/CONTRIBUTING.md) if you're interested in contributing to the colonyNetwork codebase.
 
 If you're a dapp developer looking to integrate with colony, we recommend using [colonyJS](/colonyjs/intro-welcome/) as an entry point. There you'll find analogous instructions better suited to building applications on top of the colonyNetwork. For those without patience, we have built a [colonyStarter kit](/colonystarter/docs-overview/) which contains boilerplate examples for dapp development, including frontend frameworks like react, and is the fastest way to start building with Colony.
 
 Either way, if you run into trouble or have any questions/comments, please post in our [developer forums](https://build.colony.io/).
 
-==TOC==
-
 ## Colony Network
 
 For local development and testing, follow instructions listed in the [repository readme page](https://github.com/JoinColony/colonyNetwork/blob/develop/docs/README.md).

diff --git a/docs/_Docs_Overview.md → docs/docs/overview.md b/docs/_Docs_Overview.md → docs/docs/overview.md
@@ -1,8 +1,4 @@
----
-title: Overview
-section: Docs
-order: 2
----
+# Overview
 
 *The colonyNetwork repository is developed as free software; if you are interested in contributing, or want to report an issue or bug, please see the [GitHub repository.](https://github.com/JoinColony/colonyNetwork)*
 

diff --git a/docs/_Docs_Permissions.md → docs/docs/permissions.md b/docs/_Docs_Permissions.md → docs/docs/permissions.md
@@ -1,8 +1,4 @@
----
-title: Modular Permissions
-section: Docs
-order: 4
----
+# Modular Permissions
 
 In the full implementation of the Colony protocol, decision making will be determined by the reputation score of an account. Actions that are currently permissioned, such as moving shared funds and creating a task, will be allowed proportionate to an account's reputation score. This functionality is planned for later releases.
 

diff --git a/docs/_Docs_Upgrades.md → docs/docs/upgrades.md b/docs/_Docs_Upgrades.md → docs/docs/upgrades.md
@@ -1,8 +1,5 @@
----
-title: Upgrade design
-section: Docs
-order: 3
----
+# Upgrade design
+
 The contracts comprising the Colony Network are upgradeable using the Delegate Proxy design pattern.
 
 Providing an upgrade path is important to allow for the continuous improvement of the Colony Network. At the same time, all depreciated versions of Colony should remain functional indefinitely after deployment, so that the organizations created are not predicated upon the actions/efforts of a third party.

diff --git a/docs/_Intro_Welcome.md → docs/docs/welcome.md b/docs/_Intro_Welcome.md → docs/docs/welcome.md
@@ -1,8 +1,4 @@
----
-title: Welcome
-section: Intro
-order: 0
----
+# Welcome
 
 Colony is a platform for organizations that operate via software rather than paperwork and management hierarchy.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		# Reputation Mining Cycle (`IReputationMiningCycle`)