Instadapp/boardroom-inc-protocol-Info
1
0
Fork 0
mirror of https://github.com/Instadapp/boardroom-inc-protocol-Info.git synced 2024-07-29 22:37:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Table of Contents
This commit is contained in:
Kevin Nielsen 2021-01-14 19:29:53 -05:00 committed by GitHub
parent 01129cfa59
commit 86786b200f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -23,6 +23,27 @@
</p> </p>
</p> </p>
<details open="open">
<summary>Table of Contents</summary>
<ol>
<li><a href="#structure">Repo Structure</a></li>
<li>
<a href="#adding-content">Editing Content</a>
<ul>
<li><a href="#protocol-information">Protocol Information</a></li>
<li><a href="#protocol-branding">Protocol Branding</a></li>
</ul>
</li>
<li>
<a href="#adding-content">Adding Content</a>
<ul>
<li><a href="#new-calls">Adding Call Information</a></li>
<li><a href="#new-project">Adding a New Project</a></li>
</ul>
</li>
</ol>
</details>
## **Structure** ## **Structure**
1. The `index.ts` file contains basic project metadata, as well as branding colors 1. The `index.ts` file contains basic project metadata, as well as branding colors
2. Folders for each project contain the following: 2. Folders for each project contain the following:
@ -46,8 +67,8 @@
--- ---
### How to edit Information or Branding of protocol ## **Editing Content**
#### 1.Edit protocol information #### Protocol Information
Basic information of the protocol is saved in protocols object of index.ts file Basic information of the protocol is saved in protocols object of index.ts file
``` ```
@ -62,7 +83,7 @@ Basic information of the protocol is saved in protocols object of index.ts file
Edit the corresponding value in the object and raise a new PR for changes. Edit the corresponding value in the object and raise a new PR for changes.
#### 2. Edit or add branding changes #### Protocol Branding
1. Add the unique protocol key in the object `protocolBranding` of index.ts if it does not exist. 1. Add the unique protocol key in the object `protocolBranding` of index.ts if it does not exist.
``` ```
unique_protocol_key: { unique_protocol_key: {
@ -78,7 +99,9 @@ We have a codesandbox instance https://codesandbox.io/s/boardroombranding-q3u9z
--- ---
### How to add new meeting notes ## **Editing Content**
### New Calls
Raise a new PR by following the steps below. Raise a new PR by following the steps below.
1. Create a new file in the calls folder of the protocol. Filename will be used for displaying in the list of calls page. 1. Create a new file in the calls folder of the protocol. Filename will be used for displaying in the list of calls page.
@ -87,8 +110,7 @@ Raise a new PR by following the steps below.
--- ---
### New Project
#### How to add a new protocol
Raise a new PR by following the steps below. Raise a new PR by following the steps below.
1. Add a new object to index.ts in the format of 1. Add a new object to index.ts in the format of