search

kliment / Printrun

Pronterface, Pronsole, and Printcore - Pure Python 3d printing host software
GNU General Public License v3.0
2.36k stars 997 forks source link

Docs & Wiki #812

Open laserguru opened 7 years ago

laserguru commented 7 years ago

As a new user migrating over from Repetier, I noticed there aren't docs yet nor anything on the wiki. I want to help document the software, and also help build the wiki. Is anyone working on this yet?

rockstorm101 commented 7 years ago

As far as I know, there's nobody working on this. Currently the only source for documentation is the README.md, so please go ahead.

laserguru commented 7 years ago

Great. I'm migrating over from Repetier, so I have background yet I'll learn to use Printrun from scratch. I'll document all this so others can also learn. However, I've never really contributed to a Github project before. I want to create a single place where users can suggest/ask for information for the docs. Would you suggest creating a page on the wiki, or another thread on the issues? Maybe add a label or a project? I'll begin creating the main Wiki page now, then start working on the structure and start writing some pages.

rockstorm101 commented 7 years ago

I want to create a single place where users can suggest/ask for information for the docs. Would you suggest creating a page on the wiki, or another thread on the issues? Maybe add a label or a project?

I've no idea of how a dedicated page on the wiki would work out. I've never seen that before. I would use the "Issues" system for this. It won't be docs/wiki specific but, as you suggested, a label could solve this. Anyway, I believe the wiki pages are open to be edited by anyone so there wouldn't even be need for pull requests for this kind of matters.

I'll begin creating the main Wiki page now, then start working on the structure and start writing some pages.

Great :)