Documentation example submissions idea

[EdzUpParticipant]

Looking at the Docs section on this very site does seem a bit sparse. I am wondering would it be possible to code the site so we could submit pages for the docs with examples etc.

 

One thing that makes everyone harken to Blitz3d is the excellent documentation something that with our help as a community we could rectify.

 

Thoughts?

[Mark SiblyKeymaster]

I have neither the time or skills to do this myself.

The docs are all there in github. If you want to modify/improve them, please do and make a pull request. Someone else was doing something like this with a fork of the repos I think. But, like so many other 3rd party doc related things, it just fizzled out.

So I’m afraid you’ll just have to wait until I can find some time to improve the docs.

[EdzUpParticipant]

I will have a go at adding some information and examples to the docs it will be slow going as at present I am redecorating and rebuilding parts of our home. When I get the odd moment I will go through each page and play with the command and do a basic example.

[abakoboParticipant]

Though slow, the work on the docs I started hasn’t really fizzled out.. I’m actualy desperate to have some readers that would give me confidence to do a pull request. My main problem is that english is not my mother tongue so I’m not sure of the text i’ve been writing. And I’ve been alone on this although the community was looking like there was some motivation for working on the docs.

You can see the modified docs here: http://turdus.be/monkey2docs/docs/
The forum topic about this is sticked in the developpement section (may be the fact that it is sticky makes it less visible because not upped sometime?).http://monkey2.monkey-x.com/forums/topic/integrated-docs-github-community-organisation/
I’m keeping the fork constantly up to date (and mergable) with the dev branch: https://github.com/mx2DocsCommunity/monkey2

If you want to participate i’ll be glad not to be alone on this.

As for the examples, it would need a system that let us create links from the docs to samples, idealy opening the sample in ted2(go). And I have no idea how to do that for now…
–

Attachments:

1. 

   mx2doc_table_des_mat.jpg
   

[EdzUpParticipant]

I will have a read through when I get the chance and will contact you if there is any problems or give it the thumbs up if there isn’t.  I would do the pull request as more eyes looking makes for better docs

[abakoboParticipant]

If you want admin rights on the fork just ask (and give your github id)..

[Author]

Posts