By john-mac maeve @7i7o piablo
We are creating a process where we receive educational content from DAO members, or sponsors, transfer it to Notion and then fork it to a Github branch, where we will format it into an .mdx file - the native file type for content in Academy.
The final process will be done ‘remotely’ on the Github site, so that users don’t need to learn any developer tools/skills. From there, it can be submitted for review. And all being well, finally merged to the live/production Academy site for the world to enjoy.
The educational content you have created and compiled could be in any number of places e.g. published in a Hashnode article, or in document locally on your machine. So we want to make transferring it on to D_D Academy as seamless as possible. Here is the rationale around some of the choices we made.
We chose Chromium based Brave browser ⇒ Notion workspace ⇒ Github for text and images. Brave rendered images and rich text very nicely. Firefox caused us some rendering issues. And hey, Brave has been web3 friendly since the get-go. Larger files e.g. video material will need to be stored on a web3 hosting platform. We will make it as ‘novice friendly’ for you as we can.
Making commits in Github has some standard etiquette. Since we are working in an open source project, we want our fellow contributors to easily understand at a glance the actions we have taken. So when we create a message to affirm those actions, we use a simple verb form and succinct and meaningful message headers. Github also allows us to add extra descriptions, if we need more detail.
You will be storing your content in two main directories in the Academy repository. The main text body of your lesson will be in .mdx file format and stored under the pages directory. Any images you have will be stored as assets under the public directory. You will simply create a file path to these assets from public to pages in the .mdx file. It’s really straightforward.
If larger files are stored in the same way on Github they will take ages to load when someone opens your content on the live Academy platform. And we don’t want that. We will give web3 solutions on how and where to store video and larger files.
✅ your steps as you go.
Copy your content to a Notion document
+ Add a pageNow everything is ready to be pasted into Github. Please don’t be tempted to bypass Notion and paste directly into Github. It’s not worth the hassle.