About a week ago in another thread@Tom mentioned that he was hoping for more people to dive in and start writing some MonoGame documentation.
I think this idea is great and I’m sure there are others out there willing to contribute. However, it’s not clear how we edit the documentation. If someone could enlighten us on this, that would be fantastic.
Here’s a little blurb I wrote the other day…
We need help writing the MonoGame documentation!
As you know, documentation is what separates good open source projects from forgotten ones and as it stands the MonoGame documentation is only a little way to being great. If we all band together, we can make it great!
This is call out to all MonoGame developers willing to help if you have tutorials, code snippets, experience with the various platforms, youtube videos or any other form of documentation. Let’s gather it all together in one place and make MonoGame even better.
I’ve written a new TexturePacker/MonoGame integration tutorial blog post (see other thread). I see there is a tutorial section in the MonoGame documentation that contains a link to my Spine tutorial which is cool. I’m happy to add my new blog post to this page as well, however I’m guessing that it isn’t editable by everyone (i.e. not a wiki) so I’m guessing someone else will need to add the link.
This information should probably be on the first page of the documentation.
I tried doing it myself but got a 404 error from github. Probably because I already have a MonoGame fork in my account that was forked from DDReaper’s Portable version.
It would be great to put a link on how to help contribute to the docs on the first page. Something to add to the existing “WORK IN PROGRESS” blurb I already have there.
We would love to see them, but we have to work out exactly how we would include them into the docs.
First it makes sense for the videos to just be put up on YouTube. No reason to do anything fancier than that. We can then easily include it into the current MonoGame channel in either the “Tutorial Series” or “Learn MonoGame” playlists.
Once we have it there we can consider adding a link and/or embedding select tutorials within the docs. We should probably just make these part of the regular documentation and not just have a list of video tutorials or anything. This would suggest these videos should be short and on one particular subject.
I really like the MSDN style as it provides the ability to bookmark a specific piece of documentation but it’s a living record, it changes as the platform is revved. That said, having the ability to select a version as well as platform would be really nice, will probably take a lot of work taking platform specific documentation, maybe keeping it in a section that is in-line but collapsed by default would be a better way.