From 9dde9415749e7d84e1d81e56519cea1428cba0e9 Mon Sep 17 00:00:00 2001 From: Ladd Hoffman Date: Thu, 16 May 2024 21:37:52 -0500 Subject: [PATCH] fixup --- specification/docs/requirements.md | 2 +- .../docs/system-design/{system-design.md => index.md} | 6 +++--- specification/mkdocs.yml | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) rename specification/docs/system-design/{system-design.md => index.md} (70%) diff --git a/specification/docs/requirements.md b/specification/docs/requirements.md index 3ac9e44..2fb6831 100644 --- a/specification/docs/requirements.md +++ b/specification/docs/requirements.md @@ -198,4 +198,4 @@ The Rollup contract can be thought of as a specialized form of Work Contract (WS 1. The DAO members should stake against the VP, in order to punish the batch worker for failing to complete their work -In this requirements section, we omit any details of the mechanisms for implementing the necessary off-chain validation that leads to the production and verification of the Rollup Post. We will provide those details in the [System Design](./system-design.md) section. \ No newline at end of file +In this requirements section, we omit any details of the mechanisms for implementing the necessary off-chain validation that leads to the production and verification of the Rollup Post. We will provide those details in the [System Design](./system-design) section. \ No newline at end of file diff --git a/specification/docs/system-design/system-design.md b/specification/docs/system-design/index.md similarity index 70% rename from specification/docs/system-design/system-design.md rename to specification/docs/system-design/index.md index a70f0a1..400cdca 100644 --- a/specification/docs/system-design/system-design.md +++ b/specification/docs/system-design/index.md @@ -33,7 +33,7 @@ Topics ## Contracts -In the [Requirements](./requirements.md) section, we identified the following smart contracts: +In the [Requirements](../requirements.md) section, we identified the following smart contracts: 1. Reputation 1. Bench @@ -53,11 +53,11 @@ Rather than submit every Post on-chain and conduct every Validation Pool on-chai With this Rollup Post, we have the opportunity to attribute credit to multiple authors, with a weight assigned to each author. We can express this weight as Parts Per Million (PPM), for a balance between numerical precision, and ease of visual recognition. -The Rollup Post can weight authorship in accordance with the off-chain Validation Pools that have taken place. The off-chain system can fully model the Forum and Bench outlined in the [Requirements](./requirements.md) section. For demonstration purposes, our prototype makes some simplifying assumptions. Work Evidence Posts (WEV) are assumed to contain no references to prior Posts. In reality, we want WEV to be able to reference prior Posts, such as those representing policies of the DAO, prior work by other DAO members, prior art outside the DAO, and so on. So, a proper implementation of this system should account for these references, just as the Forum contract must. +The Rollup Post can weight authorship in accordance with the off-chain Validation Pools that have taken place. The off-chain system can fully model the Forum and Bench outlined in the [Requirements](../requirements.md) section. For demonstration purposes, our prototype makes some simplifying assumptions. Work Evidence Posts (WEV) are assumed to contain no references to prior Posts. In reality, we want WEV to be able to reference prior Posts, such as those representing policies of the DAO, prior work by other DAO members, prior art outside the DAO, and so on. So, a proper implementation of this system should account for these references, just as the Forum contract must. ## Matrix -To address the need for coordination of off-chain Posts and Validation Pools, we introduce Matrix. [Matrix](matrix.org) is a messaging protocol, and it has multiple implementations. Our prototype uses Synapse as the Homeserver. Our system communicates with the Homeserver using the Client-Server protocol. +To address the need for coordination of off-chain Posts and Validation Pools, we introduce Matrix. [Matrix](https://matrix.org) is a messaging protocol, and it has multiple implementations. Our prototype uses Synapse as the Homeserver. Our system communicates with the Homeserver using the Client-Server protocol. ## Element-web Widget diff --git a/specification/mkdocs.yml b/specification/mkdocs.yml index a6fc2c3..06a3dee 100644 --- a/specification/mkdocs.yml +++ b/specification/mkdocs.yml @@ -19,12 +19,12 @@ nav: - Terminology: terminology.md - Requirements: requirements.md - System Design: - - Overview: system-design/system-design.md + - Overview: system-design/index.md - Contracts: - Reputation: system-design/contracts/reputation.md - Bench: system-design/contracts/bench.md - Work: system-design/contracts/work.md - Proposal: system-design/contracts/proposal.md - - Forum: system-design/contracts/Forum.md + - Forum: system-design/contracts/forum.md - Rollup: system-design/contracts/rollup.md - - Implementation: system-design/implementation.md + - Implementation: implementation.md