Update README.md

More Cleanup
This commit is contained in:
Kevin Nielsen 2021-01-14 19:43:18 -05:00 committed by GitHub
parent abb067f83f
commit 404a2a8b23
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -48,16 +48,11 @@
## **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:
1. A file named `overview.md` that contains a project's governance overview. This content is displayed in each project's 'Overview' tab, below its statistics. 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.
2. The `logo.png` logo file is 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.
3. The `header.png` logo file is displayed at the top of sidebar when that project is selected in the navigation.
4. The `calls` folder collects governance and community call agendas and meeting notes, displayed in each project's 'Calls' tab.
---
## **Editing Content** ## **Editing Content**
### 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
@ -97,8 +92,6 @@ Raise a new PR by following the steps below.
2. Add a summary of the call in the file. Contents of the file will be displayed in the respective note page. 2. Add a summary of the call in the file. Contents of the file will be displayed in the respective note page.
3. Raise a PR with the changes 3. Raise a PR with the changes
---
### New Project ### New Project
Raise a new PR by following the steps below. Raise a new PR by following the steps below.