Merge branch 'main' of https://github.com/boardroom-inc/protocol-Info into feat/bulk

README.md

@@ -30,141 +30,57 @@
   </p>
 </p>
 
-<details open="open">
+## About
-  <summary>Table of Contents</summary>
-  <ol>
-    <li><a href="#structure">Repo Structure</a></li>
-    <li>
-      Global Protocol Changes
-      <ul>
-        <li><a href="#protocol-information">Protocol Information</a></li>
-        <li><a href="#protocol-branding">Protocol Branding</a></li>
-      </ul>
-    </li>
-    <li>
-      Adding Content
-      <ul>
-        <li><a href="#new-content-folders">New Content Folders</a></li>
-        <li><a href="#new-content-folders">New Files</a></li>
-        <li><a href="#new-calendar-events">Calendar Events</a></li>
-        <li><a href="#new-weekly-updates">Weekly Updates</a></li>
-        <li><a href="#new-project">New Project</a></li>
-      </ul>
-    </li>
-  </ol>
-</details>
 
-## **Structure**
+All project additions and edits for information uploaded, stored, and maintained on the [Boardroom Portal](https://app.boardroom.info) occur on this public Project Information repository. [These docs](https://docs.boardroom.info/integrations/getting-started) will walk you through how to add the necessary information to this repository in a few simple steps, to get your project added to the Boardroom Portal frontend and to update its details on an ongoing basis.
-1. The `index.ts` file contains basic project metadata, as well as branding colors
-2. Folders for each project contain the following:
-    1. `overview.md` contains a project's governance overview. _This content is displayed in each project's 'Overview' tab, below its statistics._
-    2. `logo.png` is a logo file displayed in various places accross the app, including protocol switcher.
-    3. `header.png` is a logo file is displayed at the top of sidebar when that project is selected in the navigation.
-    4. `calls` is a folder collects governance and community call agendas and meeting notes, displayed in each project's 'Calls' tab.
-      
-## **Global Protocol Changes**
 
-### Protocol Information
+## Development
-Basic information of the protocol is saved in protocols object of index.ts file
 
-```
+Clone the repo:
-  protocol_key: {
-    name: "Protocol Name",
-    path: "Path used in boardroom url",
-    description: "Description of protocol",
-    suffix: "Token",
-    folder: "Folder name to host resources",
-  },
-```  
 
-Edit the corresponding value in the object and raise a new PR for changes.
+```sh
-
+$ git clone git@github.com:boardroom-inc/protocol-Info.git
-### Protocol Branding
- 1. Add the unique protocol key in the object `protocolBranding` of index.ts if it does not exist. 
-```
-unique_protocol_key: {
-    "--background-primary-nav": "#001529", // Background color for sidebar, header and header information in protocol pages
-    "--color-text-nav": "#e7e8eb", // Color of text in sidebar, header and header information in protocol pages
-    "--background-switcher-active": "#000000", // Background color of the active nav element in sidebar 
-  },
-```
- 2. Add or edit the respective color variables and colors to the above object.
- 3. Raise a PR with the changes.
- 4. These changes should be reflected on the Boardroom portal a few days after the changes have been merged.
-
-We have a codesandbox instance https://codesandbox.io/s/boardroombranding-q3u9z to visualize branding changes. Change the corresponding color variable in index.js file to have a sense of how the protocol pages will look after the updates
-
-## **Adding Content**
-Content files will be sorted by date. Add the date (dd-mm-yy) to the file name you are creating. This date will be hidden on the Boardroom portal but will sort the files by most recent.
-
-### New Content Folders
-New content folders will dynamically display a new item under the 'Resources' tab. Raise a new PR by following the steps below:
-
-1. Create a new folder inside protocol folder. _The Folder name will be the sub nav item displayed under resources in sidebar._
-2. Add content inside the folder by adding new files.
-3. Raise a PR with the changes.
-
-### New Files
-1. Create a new file in the Dynamic folder of the protocol. _The Filename will be the title displayed in the 'Folder' tab list._
-2. Add Content in the markdown file. The contents of the file will be displayed in the respective page.
-3. Raise a PR with the changes.
-
-### New Calendar Events
-
-1. Add one or more new events to the `events.json` file of the protocol using the following format:
-
-- **title**: The title of the event - this will be shown in the month and day view.
-- **url**: A URL to link to when an event is clicked.
-- **date**: The UTC date of the event in ISO 8601 format
-
-```json
-[
-  {
-    "title": "This is an example event.",
-    "url": "https://example.com",
-    "date": "2021-01-08T00:00:00.000Z"
-  },
-  {
-    "title": "This is another example event.",
-    "url": "https://example.com",
-    "date": "2021-01-10T00:00:00.000Z"
-  }
-]
 ```
 
-2. Raise a PR with the changes.
+Install dependencies:
 
-### New Weekly Updates
+```sh
-1. Create a new file in an new 'Updates' folder. _The Filename will be the title displayed in the 'Folder' tab list._ Remember to add the date to the filename (Update Title + dd-mm-yy)
+$ yarn
-2. Add Content in the markdown file. The contents of the file will be displayed in the respective page.
-3. Weekly updates should be categorized by "Live Votes", "Recent Votes", and "Discussions".
-4. For each Proposal or Discussion, add a Markdown Table with the Title, Category, and Link:
-![](https://i.ibb.co/cQg49mh/categories.png)
-*Choose from the following categories: Parameter Change, Staffing, Treasury, Marketing, Strategy, Product, Development, Meta, Other
-5. Add a short (100 words max) description under the table.
-6. Repeat the steps for every proposal or discussion relevant to that week.
-7. Raise a PR with the changes.
-
-### New Project
-Please keep in mind that the Boardroom team will need to add your project before it displays on the portal. Raise a new PR by following the steps below:
-
-1. Add a new object to index.ts in the format of
-
-```
-  protocol_key: {
-    name: "Protocol Name",
-    path: "Path used in boardroom url",
-    description: "Description of protocol",
-    suffix: "Token",
-    folder: "Folder name to host resources",
-  },
 ```
 
-2. Create a folder with the same name mentioned above in the root folder of the repo.
+Compile the protocol info artifact to `dist`:
-3. Add logo with the file name `logo.png` in the folder with an aspect ratio of 1:1. This will display in the project switcher and various other places in the app.
+
-4. Add an image `header.png` which will display at the top sidebar. Ideal dimensions are 400 × 150 (W× H)
+```sh
-5. Add a folder with the name `calls` which will contain meeting note files.
+$ yarn build
-6. Raise a PR with the changes.
+```
+
+Link the package:
+
+```sh
+$ yarn link
+```
+
+From [hub-ui](https://github.com/boardroom-inc/hub-ui) (or any other repo), use the linked package:
+
+```sh
+$ yarn link @boardroom/protocol-info
+```
+
+Run validation:
+
+```sh
+$ yarn validate
+```
+
+Cut a new release:
+
+```sh
+$ git checkout main
+$ git pull
+$ npx standard-version
+$ yarn publish
+$ git push origin main --follow-tags
+```
 
 ## Contact
 

protocols/__example/events.json

@@ -0,0 +1 @@
+[]

protocols/__example/index.json

@@ -0,0 +1,19 @@
+{
+  "cname": "example",
+  "name": "Example",
+  "description": "A concise description of the protocol",
+  "path": "example",
+  "folder": "__example",
+  "type": "snapshot",
+  "suffix": "EXP",
+  "coinGeckoPriceString": "example",
+  "tokenContractAddress": "0x0000000000000000000000000000000000000000",
+  "isEnabled": true,
+  "hasOnchain": false,
+  "isHybrid": false,
+  "hasDelegation": false,
+  "snapshotSpaceName": "example.eth",
+  "invalidSnapshots": [],
+  "discourseForum": {},
+  "safeAddress": "0x0000000000000000000000000000000000000000"
+}

protocols/__example/overview.md

@@ -0,0 +1 @@
+Overview of protocol and governance process.

protocols/compound/resources/Gov Weekly/Week 16 2021 23-04-21.md

@@ -0,0 +1,32 @@
+### Governance Update
+
+#### Live Votes
+
+
+#### Recent Votes
+
+#### Discussions
+
+| Name          | Category      | Link   |
+| ------------- |:-------------:| :-----:|
+| TrueUSD Listing Proposal | Development | [View](https://www.comp.xyz/t/trueusd-listing-proposal-stay-tuned/1490/4) |
+
+The TrueUSD team simulated supply and borrow scenarios for TUSD, and is ready to submit a formal governance propsal for adding TUSD as the next supported market on Compound.
+
+| Name          | Category      | Link   |
+| ------------- |:-------------:| :-----:|
+| Oracle Infrastructure: Chainlink Proposal | Development | [View](https://www.comp.xyz/t/oracle-infrastructure-chainlink-proposal/1272/52) |
+
+The community discusses adding Chainlink as the primary price oracle with prices anchored to within 15% of Uniswap and USDC & USDT pegged at $1.
+
+| Name          | Category      | Link   |
+| ------------- |:-------------:| :-----:|
+| F1INCH Listing Proposal | Development | [View](https://www.comp.xyz/t/1inch-listing-proposal-stay-tuned/1549) |
+
+1inchnetwork proposes adding the 1inch governance token as a supported asset on Compound.
+
+| Name          | Category      | Link   |
+| ------------- |:-------------:| :-----:|
+| Grant to PoolTogether for Launch of Tether Prize Saving Pool | Development | [View](https://www.comp.xyz/t/grant-to-pooltogether-for-launch-of-tether-prize-saving-pool/1581) |
+
+Leighton Cusack proposes a grant of 1,000 COMP that will be used as prizes to help bootstrap the PoolTogether Tether prize pool.  

scripts/build.ts

@@ -3,7 +3,9 @@ import mkdirp from "mkdirp";
 
 const protocols = fs.readdirSync("./protocols");
 
-const protocolInfo = protocols.map((protocol) => fs.readFileSync(`./protocols/${protocol}/index.json`, "utf8"));
+const protocolInfo = protocols
+  .filter((protocol) => protocol !== "__example")
+  .map((protocol) => fs.readFileSync(`./protocols/${protocol}/index.json`, "utf8"));
 
 mkdirp.sync("./dist");
 fs.copyFileSync("./types.ts", "./dist/types.ts");