Moving the assembly instructions into a wiki

I’d like to look at moving the assembly instructions into a wiki location so that it is easier to keep them from stagnating and benefit from everyone’s input.

I’m curious about what the right place to do that would be. Two options come to mind.

  1. Here in the forums.

Pros: The forums is already the hub of community to it’s easier for folks to engage with it.
Cons: The forums pages are a little ugly looking and don’t feel quite as polished as I would like the instructions to feel

  1. Github. As either a wiki page or as a markdown file.

As a wiki page like this (Home · MaslowCNC/Mechanics Wiki · GitHub)

Pros: Github is already the collaboration center of the project.
Cons: It’s a little bit harder to for folks to have to make an account there and it’s another site for folks to have to visit.

OR

As a markdown file like this:

Pros: This would support pull requests to propose changes instead of being editable by anyone to make it more of a collaborative process instead of an “anyone can change anything at any time” process. This would also let us have the MaslowBot AI update the documentation. It also seems possible to imbed this directly into the website automatically so most users wouldn’t have to read it from github.

Cons: It makes editing harder and has a steeper learning curve.

The more that I think about it, the more I’m liking the last option.

It’s a little bit more of a lift for folks who want to contribute to have to make a pull request, but I think having the ability to ask the AI to update things would be pretty fantastic, and the fact that we could make the document embed into the Squarespace page so 90+% of folks who just want things to be simple wouldn’t have to go to another website.

1 Like

Bar wrote:

As a markdown file like this:

Electronics/INSTRUCTIONS.md at master · MaslowCNC/Electronics · GitHub

Pros: This would support pull requests to propose changes instead of being editable by anyone to make it more of a collaborative process instead of an “anyone can change anything at any time” process. This would also let us have the MaslowBot AI update the documentation. It also seems possible to imbed this directly into the website automatically so most users wouldn’t have to read it from github.

Cons: It makes editing harder and has a steeper learning curve.

I would go this route, and as part of the process, I would have a video and
instruction page that walks people through an optional ‘registration’ of their
maslow by editing a page.

multiple PRs that append to a page are a problem to deal with, so structure the
page so that people will enter info in various places (say alphabetical order
and geo location, so country/state/alpha name list order)

you can even add a little markdown to do name, forum handle, github name if you
want.

David Lang

1 Like

Bar wrote:

The more that I think about it, the more I’m liking the last option.

It’s a little bit more of a lift for folks who want to contribute to have to make a pull request, but I think having the ability to ask the AI to update things would be pretty fantastic, and the fact that we could make the document embed into the Squarespace page so 90+% of folks who just want things to be simple wouldn’t have to go to another website.

the key thing for me is that the PR process will block wiki defacement and
provide a path to have the posts reviewed for accuracy

do it in a way that you can have multiple people as approvers so it’s not all on
you.

David Lang

1 Like