Documentation Project? a Wiki?
Monkey Archive Forums/Monkey Discussion/Documentation Project? a Wiki?
| ||
| Hey, maybe we should think about starting a monkey-x dokumentation Project. This is something that i really miss on monkey-x, and the vote on slant showed up, that alot ppl dislike that there is no Dokumentation for monkey-x somewhere on the web. So maybe we should think about starting a Monkey wiki where we (the community) can write docs. At first we could just copy/paste the generated monkey-docs and then add code-samples, notes, tipps, or even rewrite parts if neccesary. Also it could be possible that creators of Frameworks (diddy, ignite, minib3d) write/post theyr docu there, so that it all is in kinda same look and feel, focused on a place, where all the community can contribute to. Also we could have a place where we collect Tutorials and Manuals, (how to install target XYZ, how to create a keystore for android, how to do use sublime for monkey-x and so on) Would some of you have an interrest in such a Project? It could help to forge the community togheter,and making monkey-x look better for beginners from outside if we have a fine, searchable, well indexed documentation wiki, with wiki standart look up on the web. what do you guys think? should we? |
| ||
| Maybe pushing commits to the github repo could solve it |
| ||
| Linode recently moved all their docs to the github: https://github.com/linode/docs https://blog.linode.com/2014/07/30/linode-docs-now-open-source-on-github/ https://www.linode.com/docs We could do something like this. |
| ||
| This has been suggest a few times before. http://www.monkey-x.com/Community/posts.php?topic=6139 |
| ||
| I don't see the point of it. The monkeydocs source code is open and available, and also the modules and language documentation is on github, so the community documentation project is already there. Contribute to it if you have to time and the will to improve it! I, as instance, am migrating all my modules documentation to that system (including jungle gui one, which is huge). |
| ||
| Looking through the forums. I have seen near enough the same questions being ask over and over again (guess people are just too lazy to use the search functions). I as I see it; what is really needed is a good look through the forums and a list compiled of commonly asked questions for each forum section that should be pinned with a title saying "COMMONLY ASKED QUESTIONS. PLEASE READ BEFORE POSTING". The first thing it should say is "If you cannot find what you are looking for here. Please try the forum search before posting." before the compiled list. |
| ||
| well, all i found on github was this: https://github.com/blitz-research/monkey/tree/develop/docs/monkeydoc if you mean this, then this is not really what a doc accesible from web means. when i tryout a new programming language/engine or lib, i often just check out the docs, to see what it can. this .monkeydoc stuff is kinda useless for this, since it seems like ppl Need ted to read/open it. what i ment was, a documentation wich is not in the Need to download/install anything. so is there somewhere a web readable doc on github? i mean compared to the docs of other engines/languages the one from monkey is really poor: Corona: http://coronalabs.com/resources/ Gideros: http://giderosmobile.com/tools (click ressources on the top menu) and many more, they all have, a direct from the Website accessible documentation Portals wich links to all kinds of informations, faqs, api listings, Tools, howtos, Videos and so on. compared to this, monkey is really poor, with its only from IDE readable .monkeydoc stuff. well ist Handy to have this in the IDEs ted and jungle ofc but i ist just not enough for a professional product where ppl want/Need to pay for well the wikibooks thingie seems to be the best attempt to me for now |
| ||
| This: http://www.monkey-x.com/docs/html/Home.html |
| ||
| @Salmakis: The documentation links are at the top of the home page. And all the links are duplicated in the page footer for every page. |
| ||
| well i wonder why i never saw those, hehe, tahnkies. sorry due to my stupidity |
| ||
| well i wonder why i never saw those, hehe, tahnkies. Well, I supose you where looking for it in the "community/get help" section of the site, which IMHO is where it should have been in the first place! |
   |