Help Us Improve MonoGame Documentation!

22

The docs are created using SharpDoc (GitHub - xoofx/SharpDoc: SharpDoc is a documentation tool to generate HTML documentation for .NET projects) and it is pretty easy to use and extend. So its more a matter of deciding on a style then doing the work to implement the MSDN style drop down and then fix the build server to SFTP the docs to the correct locations.

23

Gotcha. MSDN style is nice, especially when you are dealing with updating or back-porting a code base. Also, anyone whoā€™s learned C# is surely familiar with itā€™s layout and will have an easier getting around.

24

can we add please add

http://blog.int6.org/development/monogame/easy-multi-platform-managment-with-monogame/

to others section (https://github.com/mono/MonoGame/blob/develop/Documentation/tutorials.md#others) ?

1 Like
26

Hereā€™s my contribution : MonoGameSamples

These samples are intended to newbies in MonoGame :

  • they are small and self-contained
  • addresses concepts one by one
  • commented when necessary

There are only 4 of them for now but more are to come.

Hopefully youā€™ll like them and add them to the current list of tutorials !

1 Like
27

@aybe great work. The code looks very clean a newbie friendly.

28

fixed the link: http://www.int6.org/development/monogame/easy-multi-platform-managment-with-monogame/

1 Like
30

Good evening,

I just joined the forum, but Iā€™ve been interested in helping with this effort for quite a while. Iā€™m still learning MonoGame myself, but Iā€™m an experienced developer and technical writer (Iā€™ve written a lot about teaching others how to program and learn computer science), so I feel like I can help.

Iā€™m working on migrating a project from GameMaker Studio to MonoGame, and have started writing tutorials/devlogs on how Iā€™m doing this. Here are the first two articles:
Migrating to MonoGame
Setting Up the Shared Project

Iā€™m not sure where the best place to post these devlogs is, but Iā€™m hoping they can be helpful.

Also, if thereā€™s anything specific I can do to help please let me know. If thereā€™s any notes or anything that someone has and needs to organize into a more accessible format for documentation, feel free to reach out to me. Iā€™ll read through the rest of this thread to see what else you guys have said.

Thanks!

31

@CloudyHeavenGms Check this setup up: https://github.com/harry-cpp/MonoGame/blob/newprojdocs/Documentation/setting_up_project/setting_up_project.md

It will help you create a cleaner initial project.

1 Like
32

Thanks @Apostolique!

33

I know this is old, but I remember when XNA was released. After many years I decided to pick XNA back up and make a project. I didnā€™t even know it was discontinued. I was under a rock on that one.

I am here to help! I just learned about all of this, I havenā€™t downloaded anything, but still; Iā€™m here to help. Let me know what is needed!