From 7ad2cf5bf7b338b910a5f595ae961b4c4688e56b Mon Sep 17 00:00:00 2001 From: Ladd Hoffman Date: Wed, 15 May 2024 16:48:08 -0500 Subject: [PATCH] docs --- specification/docs/requirements.md | 19 ++++++++++++------- .../docs/{design.md => system-design.md} | 0 specification/mkdocs.yml | 2 +- 3 files changed, 13 insertions(+), 8 deletions(-) rename specification/docs/{design.md => system-design.md} (100%) diff --git a/specification/docs/requirements.md b/specification/docs/requirements.md index 3fd4890..45b7cc3 100644 --- a/specification/docs/requirements.md +++ b/specification/docs/requirements.md @@ -43,17 +43,17 @@ Validation Pools mint and award Reputation (REP). REP can be used for staking fo The day to day operations of a DAO are centered around Work Smart Contracts (WSC) and Validation Pools (VPs). Customers request work; the work is assigned to an available worker; the worker submits Work Evidence (WEV); and the Work Evidence is validated by the rest of the DAO in a Validation Pool. -#### Work Smart Contract +#### Work Smart Contracts -1. A Worker must be able to stake availability toward a Work Contract (WSC), specifying the duration of their availability window. +1. A Worker may stake availability toward a Work Contract (WSC), specifying the duration of their availability window. -1. A Customer must be able to submit a request for work to the WSC, including a fee and any necessary request details. +1. A Customer may submit a request for work to the WSC, including a fee and any necessary request details. -1. The assigned Worker must be able to submit a Work Evidence Post to the WSC, providing any necessary supporting information to verify that the work was performed correctly. +1. The assigned Worker must submit a Work Evidence Post to the WSC, providing any necessary supporting information to verify that the work was performed correctly. -1. The Customer must be able to submit approval/disapproval of the work to the WSC. +1. The Customer must submit approval/disapproval of the work to the WSC. -1. The Staking Clients must be able to verify the work evidence, and stake for/against a Validation Pool targeting the Work Evidence Post. +1. The Staking Clients must verify the work evidence, and stake for/against a Validation Pool targeting the Work Evidence Post. 1. If the Validation Pool is accepted, the Worker as well as Staking Clients who staked in favor of the VP, shall receive REP rewards in proportion to their stakes. @@ -131,4 +131,9 @@ A Post may also reference the Incinerator. Any reputation donated to the Inciner - Sum of positive weights must be <= 1. - - A Post may reference the Incinerator with 0 <= weight <= 1. \ No newline at end of file + - A Post may reference the Incinerator with 0 <= weight <= 1. + +This Forum reference mechanism enables executing any conceivable change in the REP awarded to Posts and their authors. + +## Rollup + diff --git a/specification/docs/design.md b/specification/docs/system-design.md similarity index 100% rename from specification/docs/design.md rename to specification/docs/system-design.md diff --git a/specification/mkdocs.yml b/specification/mkdocs.yml index 9150df1..bf0a846 100644 --- a/specification/mkdocs.yml +++ b/specification/mkdocs.yml @@ -18,5 +18,5 @@ nav: - Overview: index.md - Terminology: terminology.md - Requirements: requirements.md - - Design: design.md + - System Design: system-design.md - Implementation: implementation.md