Restructure and add search functionality.

AxLabs · Jun 16, 2022 · 9f638b4 · 9f638b4
1 parent ca6d271
commit 9f638b4
Show file tree

Hide file tree

Showing 16 changed files with 267 additions and 69 deletions.
diff --git a/docs/1_intro.md → docs/1_General/1_intro.md b/docs/1_intro.md → docs/1_General/1_intro.md
@@ -1,5 +1,4 @@
 ---
-sidebar_position: 1
 ---
 
 # Introduction

diff --git a/docs/2_purpose.md → docs/1_General/2_purpose.md b/docs/2_purpose.md → docs/1_General/2_purpose.md
@@ -1,5 +1,4 @@
 ---
-sidebar_position: 2
 ---
 
 # Purpose

diff --git a/docs/3_program_funding.md → docs/1_General/3_program_funding.md b/docs/3_program_funding.md → docs/1_General/3_program_funding.md
@@ -1,5 +1,4 @@
 ---
-sidebar_position: 3
 ---
 
 # Treasury

diff --git a/docs/4_grants_categories.md → docs/1_General/4_grants_categories.md b/docs/4_grants_categories.md → docs/1_General/4_grants_categories.md
@@ -1,5 +1,4 @@
 ---
-sidebar_position: 3
 ---
 
 # Grants Categories

diff --git a/docs/2_Design/1_intro.md b/docs/2_Design/1_intro.md
@@ -0,0 +1,62 @@
+---
+---
+
+# Introduction
+
+This part describes the technical materialisation of the GrantShares program in the form of a governance dApp.
+
+The technical implementation of GrantShares consists of four parts:
+- Smart contracts
+- GitHub issues
+- Web Frontend
+- Backend
+
+ that allows users to submit, discuss, view, endorse, vote on, and execute proposals. 
+(smart contracts + web page + GitHub issues) 
+Each proposal leads to pre-determined actions that are executed on-chain if approved. Discussion on proposals takes place via GitHub issues. 
+
+The GrantShares Governance dApp has the following properties:
+
+- GrantShares is permissioned. Membership requires a proposal and, therefore, approval of the existing members. Voting rights cannot be bought. There is no token involved in membership.
+- Each member has equal voting power, i.e., one vote per member per proposal.
+- The GrantShares treasury contract owns the assets used for grants.
+- The treasury can only receive funding from addresses that were previously whitelisted via a proposal.
+- The treasury can only receive tokens that were previously whitelisted via a proposal.
+- Proposals are generic, they can include any intents that are executable on-chain.
+
+## Proposals
+
+A "Proposal" is an instrument with which anyone can suggest on-chain changes by invocation of smart contract methods that the DAO has authority over.
+
+Technically speaking, a Proposal $p$ is a set of method calls $X$ with parameters $Y$ on smart contracts $Z$. If the DAO Members approve of $p$, then the DAO smart contract will execute it, i.e., calls methods $X$ with params $Y$ on the smart contracts $Z$.
+
+***Anyone can create a proposal via the dApp or directly on-chain.***
+
+### Proposal Phases & States
+
+A proposal goes through the following life cycle, which are also depicted in the state diagram below.
+
+- **Discussion**
+The proposal was created via the dApp web page and is open for discussion. The discussion takes place on a GitHub issue, which is automatically created for the proposal (by the GrantShares bot).
+- **Cancelled**
+The proposal was cancelled by the creator or the GrantShares bot (in-case of inactivity) before it was put on-chain. The GitHub issue is closed.
+- **On-Chain**
+A proposal under discussion is created on the Neo blockchain, i.e., on the GrantShares contract. At this point, the proposal has to wait for the endorsement of a member before the rest of its life cycle begins.
+- **Expired**
+If the proposal isn't endorsed for a defined time period it expires. The period is defined by a contract parameter. After it is expired it can no longer be endorsed and becomes useless. The corresponding GitHub issue is closed by the bot.
+- **Review**
+The first phase of a proposal on-chain is the review phase. It allows the members to form an opinion on it before voting starts. Voting is not possible in this phase. Because discussion already takes place before the proposal is created on-chain this phase will probably be set to zero length.
+- **Voting** 
+The proposal is active and open for voting by the members.
+- **Rejected**
+If, after voting, the proposal didn't reach the quorum or the majority it goes into the Rejected state.
+- **Time lock** 
+If the proposal was approved it goes into a time lock state before it can be executed. This phase exists for security. Such, that if something is deemed to be wrong with the proposal, GrantShares members could still react and pause the contract.
+- **Accepted**
+After the time lock phase the proposal is in the Accepted state and can be executed. Execution requires an invocation from outside of the contract.
+- **Expired**
+If the proposal isn't executed for a defined time period it expires. The period is defined by a contract parameter. After it is expired it can no longer be executed even if it was accepted.
+- **Executed**
+Once executed, the proposal has reached the end of its lifecycle.
+
+![GrantShares diagrams.png](../img/proposal_flow.png)
diff --git a/docs/3_Implementation/1_intro.md b/docs/3_Implementation/1_intro.md
@@ -0,0 +1,4 @@
+---
+---
+
+# Introduction
diff --git a/docs/img/proposal_flow.png b/docs/img/proposal_flow.png
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -12,17 +12,16 @@ const config = {
   baseUrl: '/',
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
-  favicon: 'img/logo.svg',
+  favicon: 'img/favicon.ico',
   organizationName: 'AxLabs',
   projectName: 'grantshares-docs',
   deploymentBranch: 'gh-pages',
-  trailingSlash:false,
-  plugins: [],
+  trailingSlash: false,
+  plugins: [ ],
   presets: [
     [
-      'classic',
-      /** @type {import('@docusaurus/preset-classic').Options} */
-      ({
+      '@docusaurus/preset-classic',
+      {
         docs: {
           sidebarPath: require.resolve('./sidebars.js'),
           editUrl: 'https://github.com/axlabs/grantshares-docs/tree/main/',
@@ -33,41 +32,60 @@ const config = {
         },
         theme: {
           customCss: require.resolve('./src/css/custom.css'),
-        },
-      }),
+        }
+      }
+    ]
+  ],
+  themes: [
+    [
+      // Using https://github.com/easyops-cn/docusaurus-search-local for the search bar.
+      require.resolve("@easyops-cn/docusaurus-search-local"),
+      {
+        hashed: true,
+        language: ["en"],
+        docsDir: "docs", 
+        docsRouteBasePath: "/docs",
+        indexDocs:true,
+        indexPages: true,
+      },
     ],
   ],
-
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
+      image: 'img/logo.svg',
+      colorMode: {
+        defaultMode: 'light',
+        disableSwitch: true,
+        respectPrefersColorScheme: false,
+      },
       navbar: {
-        title: 'GrantShares',
+        title: '',
+        style: 'primary',
         logo: {
           alt: 'GrantShares Logo',
-          src: 'img/logo.svg',
+          src: 'img/logo_and_title.png',
         },
         items: [
-          {
-            type: 'doc',
-            docId: 'intro',
-            position: 'left',
-            label: 'Docs',
-          },
           // {
-          //   to: 'blog', 
+          //   type: 'doc',
+          //   docId: 'General/intro',
           //   position: 'left',
-          //   label: 'Blog', 
+          //   label: 'Docs',
           // },
           {
-            href: 'https://grantshares.io/',
-            label: 'App',
+            href: 'https://grantshares.io/app/proposals',
+            label: 'Application',
             position: 'right',
           },
+          {
+            type: 'search',
+            position: 'right',
+          }
         ],
       },
       footer: {
-        style: 'dark',
+        style: 'light',
         links: [
           {
             title: 'Community',
@@ -90,8 +108,8 @@ const config = {
                 href: 'https://github.com/axlabs/grantshares',
               },
               {
-                label: 'App',
-                href: 'https://dev.grantshares.io/app/proposals',
+                label: 'Application',
+                href: 'https://grantshares.io/app/proposals',
               },
             ],
           },
@@ -105,4 +123,4 @@ const config = {
     }),
 };
 
-module.exports = config;
+module.exports = config;
diff --git a/package.json b/package.json
@@ -16,6 +16,7 @@
   "dependencies": {
     "@docusaurus/core": "^2.0.0-beta.21",
     "@docusaurus/preset-classic": "^2.0.0-beta.21",
+    "@easyops-cn/docusaurus-search-local": "^0.27.1",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.1.1",
     "prism-react-renderer": "^1.3.1",

diff --git a/src/css/custom.css b/src/css/custom.css
@@ -6,14 +6,15 @@
 
 /* You can override the default Infima variables here. */
 :root {
-  --ifm-color-primary: #2e8555;
+  --ifm-color-primary: #173037;
   --ifm-color-primary-dark: #29784c;
   --ifm-color-primary-darker: #277148;
   --ifm-color-primary-darkest: #205d3b;
   --ifm-color-primary-light: #33925d;
   --ifm-color-primary-lighter: #359962;
   --ifm-color-primary-lightest: #3cad6e;
   --ifm-code-font-size: 95%;
+  --search-local-modal-background: #173037;
 }
 
 /* For readability concerns, you should choose a lighter palette in dark mode. */

diff --git a/src/pages/index.js b/src/pages/index.js
@@ -1,32 +1,6 @@
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import HomepageFeatures from '@site/src/components/HomepageFeatures';
-import Layout from '@theme/Layout';
-import clsx from 'clsx';
 import React from 'react';
-import styles from './index.module.css';
-
-function HomepageHeader() {
-  const { siteConfig } = useDocusaurusContext();
-  return (
-    <header className={clsx('hero hero--primary', styles.heroBanner)}>
-      <div className="container">
-        <h1 className="hero__title">{siteConfig.title}</h1>
-        <p className="hero__subtitle">{siteConfig.tagline}</p>
-      </div>
-    </header>
-  );
-}
+import {Redirect} from '@docusaurus/router';
 
 export default function Home() {
-  const { siteConfig } = useDocusaurusContext();
-  return (
-    <Layout
-      title={`${siteConfig.title}`}
-      description="Description will go into a meta tag in <head />">
-      <HomepageHeader />
-      <main>
-        <HomepageFeatures />
-      </main>
-    </Layout>
-  );
-}
+  return <Redirect to="/docs/General/intro" />;
+};
diff --git a/static/img/favicon.ico b/static/img/favicon.ico
diff --git a/static/img/logo_and_title.png b/static/img/logo_and_title.png
diff --git a/static/img/tutorial/docsVersionDropdown.png b/static/img/tutorial/docsVersionDropdown.png
diff --git a/static/img/tutorial/localeDropdown.png b/static/img/tutorial/localeDropdown.png