Add docs workspace ported from GitBook

Author: Corantin

Doc/.gitignore

@@ -0,0 +1,4 @@
+.next
+out
+node_modules
+.DS_Store

Doc/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/pages/building-your-application/configuring/typescript for more information.

Doc/next.config.mjs

@@ -0,0 +1,14 @@
+import nextra from 'nextra'
+
+const withNextra = nextra({
+  theme: 'nextra-theme-docs',
+  themeConfig: './theme.config.tsx',
+  defaultShowCopyCode: true,
+})
+
+export default withNextra({
+  reactStrictMode: true,
+  eslint: {
+    ignoreDuringBuilds: true,
+  },
+})

Doc/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "gardens-docs",
+  "private": true,
+  "version": "0.1.0",
+  "type": "module",
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "lint": "next lint",
+    "import": "python ./scripts/import_gitbook.py"
+  },
+  "dependencies": {
+    "next": "^14.2.5",
+    "nextra": "^3.2.3",
+    "nextra-theme-docs": "^3.2.3",
+    "zod": "^3.25.3",
+    "react": "18.2.0",
+    "react-dom": "18.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.12.7",
+    "@types/react": "^18.2.46",
+    "typescript": "^5.5.4"
+  }
+}

Doc/pages/_app.tsx

@@ -0,0 +1,8 @@
+import type { AppProps } from 'next/app'
+import 'nextra-theme-docs/style.css'
+
+function App({ Component, pageProps }: AppProps) {
+  return <Component {...pageProps} />
+}
+
+export default App

Doc/pages/_meta.ts

@@ -0,0 +1,24 @@
+const meta = {
+  "index": {
+    "title": "Introduction"
+  },
+  "the-covenant": {
+    "title": "The Covenant"
+  },
+  "coordination-hierarchy": {
+    "title": "COORDINATION HIERARCHY"
+  },
+  "conviction-voting": {
+    "title": "CONVICTION VOTING"
+  },
+  "start-here": {
+    "title": "START HERE"
+  },
+  "growth": {
+    "title": "GROWTH"
+  },
+  "proposals": {
+    "title": "Proposals"
+  }
+}
+export default meta

Doc/pages/conviction-voting/_meta.ts

@@ -0,0 +1,15 @@
+const meta = {
+  "conviction-101": {
+    "title": "Conviction 101"
+  },
+  "conviction-pool-types": {
+    "title": "Conviction Pool Types"
+  },
+  "conviction-parameters": {
+    "title": "Conviction Parameters"
+  },
+  "conviction-metrics": {
+    "title": "Conviction Metrics"
+  }
+}
+export default meta

Doc/pages/conviction-voting/conviction-101.mdx

@@ -0,0 +1,17 @@
+---
+title: "Conviction 101"
+---
+
+Conviction Voting is a disputable, time-weighted voting mechanism where proposal support grows in strength the longer it's allocated (and shrinks over time if support is removed).
+
+It encourages ongoing participation, favoring consistent, long-term ideas and contributors, and it protects communities from short-term manipulation and abuse.
+
+The mechanism was first conceived by BlockScience in 2019: [https://github.com/BlockScience/conviction](https://github.com/BlockScience/conviction)
+
+## Terms to Know
+
+- **Support:** the total voting weight allocated to a proposal. 
+- **Conviction:** accumulates over time based on both the level of support on a proposal and the duration defined by the Conviction Growth parameter.
+- **Parameters: **functions that can be customized in a Pool that determine how conviction and threshold are calculated.
+- **Threshold: **in a Funding Pool, the level of conviction where funding can be executed
+- **Pool: **A Conviction Voting module in a Community.

Doc/pages/conviction-voting/conviction-metrics.mdx

@@ -0,0 +1,9 @@
+---
+title: "Conviction Metrics"
+---
+
+CV charts are graphical representations of the allocated pool weight and the accumulated conviction associated with that allocation.
+
+The funding pool includes a threshold goal.
+
+![The proposal has passed the support threshold requirement and conviction is growing. Once conviction reaches the 2.96 threshold, the proposal will be ready to be executed !](/media/fJMVaQlMZFHdwRlbHI0a-Screenshot-2024-08-13-at-4.24.33-PM.png)

Doc/pages/conviction-voting/conviction-parameters.mdx

@@ -0,0 +1,40 @@
+---
+title: "Conviction Parameters"
+---
+
+Conviction Voting allows proposals to be evaluated continuously and concurrently. Participants can express their preferences for the proposals they support, and their support accumulates over time. Any actions connected to a Conviction Voting Pool - like a funding distribution - are only executable when Conviction reaches a calculated threshold.
+
+## Conviction growth
+
+**Pool Types = Funding, Signaling, Streaming**
+
+Determines the rate at which a proposal accumulates conviction.
+
+A higher value for Conviction Growth means proposals will take longer to accumulate strength based on their support. This parameter is logarithmic and represents its "half-life," or the amount of time for conviction to reach 50% of its support.
+
+Example:
+
+- Conviction Growth = 7 days.
+- Alice has 10% of a Pool's voting weight, and supports Proposal B with all of her voting weight. After leaving her support allocated for 14 days, conviction on Proposal B is 7.5%, or 2 half-lifes.
+
+## Minimum Conviction
+
+**Pool Types = Funding, Streaming**
+
+In a Funding Pool, minimum conviction is the minimum voting weight needed for a proposal to pass. This parameter is defined as a percentage of total voting weight in a pool, and sets the amount of conviction needed for the smallest possible funding proposal (i.e. 0 tokens) to pass.
+
+In a Streaming Pool, minimum conviction is the percentage of voting weight needed for the tokens to begin streaming.
+
+## Spending Limit
+
+**Pool Types = Funding**
+
+The spending limit caps the number of tokens that can be requested in a single proposal. This parameter is defined as a percentage of tokens in the funding pool, and sets the amount of tokens requested where the proposal cannot be passed because 100% of the Pool's voting weight would need to accumulate conviction.
+
+## Fixed Minimum Threshold
+
+**Pool Types = Funding**
+
+This threshold is a fixed value representing the minimum voting weight that conviction must reach for a proposal to pass.
+
+This parameter overrides the Minimum Conviction parameter when its value is greater, and is a safeguard for newly created Pools or Pools that for any other reason do not have enough voting weight activated for funds to be considered secure.