From d484803d9aeffef2c5481d521589a850de2b6b92 Mon Sep 17 00:00:00 2001 From: Jack Hodgkinson <30505104+jhodgdev@users.noreply.github.com> Date: Wed, 2 Feb 2022 14:09:09 +0000 Subject: [PATCH] coordination of technical docs --- docs/meta/status-format.md | 4 ++-- docs/tech-design/effects.md | 18 ++++++++++++------ docs/tech-design/governor.md | 18 ++++++++++++------ docs/tech-design/treasury.md | 18 ++++++++++++------ docs/tech-design/vesting.md | 25 ++++++++++++++++--------- 5 files changed, 54 insertions(+), 29 deletions(-) diff --git a/docs/meta/status-format.md b/docs/meta/status-format.md index 2a71ee8..9daddb1 100644 --- a/docs/meta/status-format.md +++ b/docs/meta/status-format.md @@ -17,9 +17,9 @@ This format should be used at the start of any documentation that may be conside The format is as follows, with {substitutions} in curly braces. -| Specification | Implementation | Last Revision | +| Specification | Implementation | Last revision | |:-------------:|:--------------:|:-------------:| -| {status} | {status} | {version}, {date} | +| {status} | {status} | {version} {date} | -------------------- diff --git a/docs/tech-design/effects.md b/docs/tech-design/effects.md index 4ebef20..aa88ba8 100644 --- a/docs/tech-design/effects.md +++ b/docs/tech-design/effects.md @@ -1,13 +1,19 @@ -| Spec Status | Impl Status | Last Revision | -|-------------|----------------|---------------| -| WIP | WIP | v0.1 22/01/26 | +# Effects technical design + +| Specification | Implementation | Last revision | +|:-----------:|:--------------:|:-------------:| +| WIP | WIP | v0.1 2022-01-26 | *** -**Spec Ownership:** [Jack Hodgkinson](github.com/jhodgdev) +**Specification ownership:** [Jack Hodgkinson] -**Impl Ownership:** _unassigned_ +**Authors**: -**Authors**: [Jack Hodgkinson](github.com/jhodgdev) +- [Jack Hodgkinson] + +**Implementation ownership:** _unassigned_ + +[Jack Hodgkinson]: https://github.com/jhodgdev **Current Status**: diff --git a/docs/tech-design/governor.md b/docs/tech-design/governor.md index 4ebef20..85bf7e6 100644 --- a/docs/tech-design/governor.md +++ b/docs/tech-design/governor.md @@ -1,13 +1,19 @@ -| Spec Status | Impl Status | Last Revision | -|-------------|----------------|---------------| -| WIP | WIP | v0.1 22/01/26 | +# Governor technical design + +| Specification | Implementation | Last revision | +|:-----------:|:--------------:|:-------------:| +| WIP | WIP | v0.1 2022-01-26 | *** -**Spec Ownership:** [Jack Hodgkinson](github.com/jhodgdev) +**Specification ownership:** [Jack Hodgkinson] -**Impl Ownership:** _unassigned_ +**Authors**: -**Authors**: [Jack Hodgkinson](github.com/jhodgdev) +- [Jack Hodgkinson] + +**Implementation ownership:** _unassigned_ + +[Jack Hodgkinson]: https://github.com/jhodgdev **Current Status**: diff --git a/docs/tech-design/treasury.md b/docs/tech-design/treasury.md index 4ebef20..719ff58 100644 --- a/docs/tech-design/treasury.md +++ b/docs/tech-design/treasury.md @@ -1,13 +1,19 @@ -| Spec Status | Impl Status | Last Revision | -|-------------|----------------|---------------| -| WIP | WIP | v0.1 22/01/26 | +# Treasury technical design + +| Specification | Implementation | Last revision | +|:-----------:|:--------------:|:-------------:| +| WIP | WIP | v0.1 2022-01-26 | *** -**Spec Ownership:** [Jack Hodgkinson](github.com/jhodgdev) +**Specification ownership:** [Jack Hodgkinson] -**Impl Ownership:** _unassigned_ +**Authors**: -**Authors**: [Jack Hodgkinson](github.com/jhodgdev) +- [Jack Hodgkinson] + +**Implementation ownership:** _unassigned_ + +[Jack Hodgkinson]: https://github.com/jhodgdev **Current Status**: diff --git a/docs/tech-design/vesting.md b/docs/tech-design/vesting.md index de8cf87..f10ad04 100644 --- a/docs/tech-design/vesting.md +++ b/docs/tech-design/vesting.md @@ -1,20 +1,27 @@ # Vesting contract technical design -| Spec Status | Impl Status | Last Revision | -|-------------|-------------|---------------| -| WIP | WIP | 2022-01-18 | +| Specification | Implementation | Last revision | +|:-----------:|:--------------:|:-------------:| +| WIP | WIP | v0.1 2022-01-26 | --------------------- +*** -**Spec Ownership:** [@Emily Martins] +**Specification ownership:** [Emily Martins] -**Authors**: [@Emily Martins] +**Authors**: -**Impl Owner:** [@Emily Martins] +- [Emily Martins] +- [Jack Hodgkinson] -[@Emily Martins]: https://github.com/emiflake +**Implementation ownership:** [Emily Martins] --------------------- +[Jack Hodgkinson]: https://github.com/jhodgdev + +[Emily Martins]: https://github.com/emiflake + +**Current Status**: + +*** ## Vesting contract