search

threedesigns / printNC

100% Free and Open Source, the PrintNC is the next generation of high performance, affordable CNC machines
Creative Commons Attribution 4.0 International
200 stars 33 forks source link

What items would you like to see in the github repo vs the wiki and vs the website? #36

Open giesberge opened 4 years ago

JoshuaGranger commented 4 years ago

I am a strong believer of organization and documentation. I think this project can go a very long ways with a little bit of effort.

In my opinion, we have to go to great lengths to ensure that the documentation we present to new users is always up-to-date. I think one of the concerns about the Wiki is that the information isn't tied to a version of the project. For example, if we have a wiki page that gives a recommendation on exact print settings for every item in the build -- that would lend itself to becoming outdated because the list of printed items will certainly change over time.

Maybe a criteria for Wiki vs. Doc is "does this information apply specifically to this version of the machine?"

For example: E-Stop theory and best practices is not exclusive to V2.1. Configuring a Raspberry Pi to communicate with a Mesa 7I76E board is not exclusive to V2.1. Best practices for drilling and tapping steel is not exclusive to V2.1. Those are great candidates for Wiki articles.

On the other hand, a Bill of Materials is specific to V2.1. A list of printed parts is specific to V2.1. An assembly guide is specific to V2.1. These are great candidates for version-associated Docs. Each new version of the machine should have an accompanying update to the BOM, the printed parts list, and the assembly guide.

JoshuaGranger commented 4 years ago

I did some research and I see that we can make version-specific pages on the Wiki. However, I am concerned that we cannot create issues/pull requests on Wiki articles. IMO that's a good reason to do most of the documentation in the Documentation folder. This is a good read: https://stackoverflow.com/questions/10642928/how-to-pull-request-a-wiki-page-on-github

JoshuaGranger commented 4 years ago

As far as what information to show on the website: I think the website should have promo information (pictures, videos), the frame-size calculator, and a link to Discord/Github.