This public repo contains project information which will be served to display on the Boardroom Governance Portal
Browse the Portal »
Landing
·
Discord
·
Get In Touch
Table of Contents
- Repo Structure
- Global Protocol Changes
- Adding Content
- The
index.ts
file contains basic project metadata, as well as branding colors - Folders for each project contain the following:
overview.md
contains a project's governance overview. This content is displayed in each project's 'Overview' tab, below its statistics.logo.png
is a logo file displayed in various places accross the app, including protocol switcher.header.png
is a logo file is displayed at the top of sidebar when that project is selected in the navigation.calls
is a folder collects governance and community call agendas and meeting notes, displayed in each project's 'Calls' tab.
Basic information of the protocol is saved in protocols object of index.ts file
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.
- 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
},
- Add or edit the respective color variables and colors to the above object.
- Raise a PR with the changes.
- 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
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 will dynamically display a new item under the 'Resources' tab. Raise a new PR by following the steps below:
- Create a new folder inside protocol folder. The Folder name will be the sub nav item displayed under resources in sidebar.
- Add content inside the folder by adding new files.
- Raise a PR with the changes.
- Create a new file in the Dynamic folder of the protocol. The Filename will be the title displayed in the 'Folder' tab list.
- Add Content in the markdown file. The contents of the file will be displayed in the respective page.
- Raise a PR with the changes.
- 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
[
{
"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"
}
]
- Raise a PR with the changes.
- 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)
- Add Content in the markdown file. The contents of the file will be displayed in the respective page.
- Weekly updates should be categorized by "Live Votes", "Recent Votes", and "Discussions".
- For each Proposal or Discussion, add a Markdown Table with the Title, Category, and Link:
*Choose from the following categories: Parameter Change, Staffing, Treasury, Marketing, Strategy, Product, Development, Meta, Other
- Add a short (100 words max) description under the table.
- Repeat the steps for every proposal or discussion relevant to that week.
- Raise a PR with the changes.
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:
- 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",
},
- Create a folder with the same name mentioned above in the root folder of the repo.
- 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. - Add an image
header.png
which will display at the top sidebar. Ideal dimensions are 400 × 150 (W× H) - Add a folder with the name
calls
which will contain meeting note files. - Raise a PR with the changes.
Please reach out in Discord with any questions!
- Boardroom Support Channel - #❓support