Workflow for documentation publishing

[dissentertainer]

Problem

Official MoonDAO documentation is scattered around Discord channels, Notion, and other tools, making it hard to find. In addition, non-technical users may not be familiar with git or Github, making it harder for documentation to get published. The DAO does not have a system where non-technical users can draft and comment on documentation that can then be published to the website by the repository maintainers.

Goal

Everyone at MoonDAO should feel comfortable creating documentation for their work areas, regardless of technical skill.

Proposed solution

DAO member @boilerrat has proposed that we use HackMD, which is used successfully by Raid Guild for just this purpose. For an example, see the Raid Guild Handbook (Github repo). A rough outline of how this might work is:

1. Website dev team pulls all existing articles from Github into HackMD for editing.
2. A DAO member or members who want to create or edit official documentation create free HackMD accounts and ask the website dev team to add them to the MoonDAO HackMD workspace.
3. Content creators/editors do their thing, comment, argue, hug it out, until they have their final copy.
4. Content creators/editors ping a member of the website dev team to publish the document to Github (since not everyone has Github accounts or write direct access to the repository).

Things to consider

• We will need to think about what branch we push to since the main branch is protected to prevent accidents. We could create a hackmd_updates branch or use the existing staging branch as a bridge from HackMD and then do our normal PR process from there, but we would probably want to make sure there is a process for keeping that branch in sync with main if people are making PRs into main for other reasons from outside of HackMD.
• Content editors will need to learn markdown. Which shouldn't be that big of a deal since markdown is simple and also awesome.
• It would be great to develop a 'How to write great documentation' guide in our docs. A style guide too, but that's probably not in the scope of this team.

[dissentertainer]

@drewbent This is an overview of the thinking to date on how we can set up a publishing workflow for non-technical DAO members. @boilerrat might have more insight based on how Raid Guild has theirs set up (or maybe we can find it in their documentation :-)

[boilerrat]

DAOhaus has a good style guide for this done that we could potentially emulate.

[boilerrat]

https://github.com/HausDAO/daohaus-website/blob/staging/docs/handbook/contributors/contributors-docs-style-guide.mdx

[boilerrat]

Also this guide for making contributions. Much of this will change soon as there is a push to move task boards elsewhere, with a site that integrates directly with GitHub dework.

https://github.com/HausDAO/daohaus-website/blob/staging/docs/handbook/contributors/contributors-docs.mdx

https://dework.xyz/