GameMonetize Posted January 19, 2015 Share Posted January 19, 2015 I know you prayed for it;) Guess what, thanks to Temechon and his team we now have a dedicated site for the documentation:http://doc.babylonjs.com The great thing is that anyone can contribute and the content is curated by Wingnut and me! (We are looking for others curators btw) So please, have a look, try it, test it and use this post to give feedbacks HugoMcPhee, Dad72, iiceman and 4 others 7 Quote Link to comment Share on other sites More sharing options...
Temechon Posted January 19, 2015 Share Posted January 19, 2015 Yeah !!!! Quote Link to comment Share on other sites More sharing options...
Dad72 Posted January 19, 2015 Share Posted January 19, 2015 It's cool. Thank you. Missing more than small sample code to use cases and doc would be perfect (I could contribute to it). good work, I like a lot. Quote Link to comment Share on other sites More sharing options...
GameMonetize Posted January 19, 2015 Author Share Posted January 19, 2015 Please contribute! this is why we did it! Quote Link to comment Share on other sites More sharing options...
gryff Posted January 20, 2015 Share Posted January 20, 2015 Please contribute! this is why we did it! Well DK, I just made my first contribution. I guess it has gone to the curators as I can no longer see or access it. I have a second contribution - but I'm waiting to see the final outcome of the first one I know next to nothing about "markdown" - so I used a little program called MarkDownPad - the free version. Seems to handle everything I need. The term "curators" made me laugh - I had a mental picture of grey haired old men/women in a musty old library or museum Hardly the hitech boys and girls of BJS cheers, gryff Quote Link to comment Share on other sites More sharing options...
jerome Posted January 20, 2015 Share Posted January 20, 2015 YEEAAAAAHHHHHHHHH cool !!! just a question : I guess class documentation is generated from code comments, isn't it ?So if I edit this kind of documentation to add details, call examples, etc, will this edit be kept ? No risk of class doc regeneration ? Quote Link to comment Share on other sites More sharing options...
Temechon Posted January 20, 2015 Share Posted January 20, 2015 Hey gryff, Your page should be visible. @Jerome : Yes, class documentation is generated from code, but we created a system to retrieve all comment written from the website and add it to the new version. So don't worry, everything will be kept jerome 1 Quote Link to comment Share on other sites More sharing options...
jerome Posted January 20, 2015 Share Posted January 20, 2015 I really really llike the template used here : nice and ergonomicI wish there would be a link to the related github code in each class documentation, this is very useful to understand what the method/class/objects does if the doc is not enough accurate. Quote Link to comment Share on other sites More sharing options...
Temechon Posted January 20, 2015 Share Posted January 20, 2015 Thanks It should be possible to add this this in a next version Quote Link to comment Share on other sites More sharing options...
Dad72 Posted January 20, 2015 Share Posted January 20, 2015 Is it possible that when you click on a menu link, that always go top of the page. I mean, when changing link it back to top. Quote Link to comment Share on other sites More sharing options...
jerome Posted January 20, 2015 Share Posted January 20, 2015 @Temechon : Don't you have a valid certificate on your server so we could login/register in https instead of http ? Quote Link to comment Share on other sites More sharing options...
jerome Posted January 20, 2015 Share Posted January 20, 2015 suggestion :would it be possible to have the method class list under the class folder in the left menu ? ex : I open Classesthen 1.1.4then BABYLONthen Vector3would be nice if the Vector3 method list would display just under the Vector3 folder here, each entry being a link to the full method documentation in the main frame Quote Link to comment Share on other sites More sharing options...
Temechon Posted January 20, 2015 Share Posted January 20, 2015 @Dad72 : This can be easily implemented. @Jerome : No https in the roadmap for now (but that can change). Methods of the class displayed in the hierarchy can be implemented in a v2. Quote Link to comment Share on other sites More sharing options...
Dad72 Posted January 20, 2015 Share Posted January 20, 2015 @Dad72 : This can be easily implemented. Cool. Is it also possible that this is not grouped in alphabetical order, but grouped thematically. For exemple: - Actions: ---- Action ---- Event ---- Manager ---- Condition ---- - Optimizations engines: ---- ---- - Special FX: ---- ---- - Math: ---- Vector4 ---- Vector3 ---- Vector2 ---- Ray ---- Quaternion ---- ---- -Textures: ----Material ----Render target textures ----Dynamic textures (canvas) ----Video textures ----DDS textures ----TGA textures ---- - Cameras: ---- Arc rotate camera ---- Free camera ---- Touch camera ---- Anaglyph camera ---- Virtual Joysticks camera ---- Oculus Rift camera ---- Gamepad camera ---- VR Device Oriention camera ---- WebVR camera ---- Follow camera ---- This would greatly facilitate the search for everyone. This would reduce the large menu too also. Quote Link to comment Share on other sites More sharing options...
Temechon Posted January 20, 2015 Share Posted January 20, 2015 @Dad72 => It's not possible right now. The list is created according to the typescript file, where all subclasses extends the root class. Quote Link to comment Share on other sites More sharing options...
Dad72 Posted January 20, 2015 Share Posted January 20, 2015 Arf, Quote Link to comment Share on other sites More sharing options...
JCPalmer Posted January 20, 2015 Share Posted January 20, 2015 @Dad72 => It's not possible right now. The list is created according to the typescript file, where all subclasses extends the root class. Taking a quick look, the real issue is finding the Camera, Lights, & meshes. They are subclasses of Node. If some kind of double mapping of these can be done, so they can be more easily found, would be very desirable. They are kind of the heart of the architecture. Quote Link to comment Share on other sites More sharing options...
GameMonetize Posted January 20, 2015 Author Share Posted January 20, 2015 keep in mind this is the very first version:) Please use the uservoice to keep track of all your good ideas Quote Link to comment Share on other sites More sharing options...
joshcamas Posted January 21, 2015 Share Posted January 21, 2015 YESSSSSSSSSSSSSSSSSSSS Quote Link to comment Share on other sites More sharing options...
RaananW Posted January 22, 2015 Share Posted January 22, 2015 Hey people, I very much like the idea of the new documentation! The tutorials are much more structured, submitting works better (not a public wiki but a moderated version of it). I do however have a small problem with the Classes documentation. The best example is - Please find the Mesh class. Now, as a beginner, I would never have guessed that a mesh extends AbstractMesh, and that AbstractMesh extends Node. Mesh (and again, this is only an example, Camera class is the same) is one of the most important classes. Should be at the top level. Try searching for Mesh, you get a lot of pages, but... try finding the mesh class :-) I think a Wiki is wonderful for tutorials, intros etc'. For code documentation we can find something better. JSDocs, Doxygen, are both wonderful generators for code documentation. And since we are already using gulp, why not use - http://typedoc.io/ and generate the docs automatically from the TS files? jerome and Dad72 2 Quote Link to comment Share on other sites More sharing options...
Dad72 Posted January 22, 2015 Share Posted January 22, 2015 Hey people, I very much like the idea of the new documentation! The tutorials are much more structured, submitting works better (not a public wiki but a moderated version of it). I do however have a small problem with the Classes documentation. The best example is - Please find the Mesh class. Now, as a beginner, I would never have guessed that a mesh extends AbstractMesh, and that AbstractMesh extends Node. Mesh (and again, this is only an example, Camera class is the same) is one of the most important classes. Should be at the top level. Try searching for Mesh, you get a lot of pages, but... try finding the mesh class :-) I think a Wiki is wonderful for tutorials, intros etc'. For code documentation we can find something better. JSDocs, Doxygen, are both wonderful generators for code documentation. And since we are already using gulp, why not use - http://typedoc.io/ and generate the docs automatically from the TS files? I also agree with this. That is why I proposed this (On the same topic) http://www.html5gamedevs.com/topic/11844-official-documentation-site/?p=68383 I like good also http://typedoc.io/ Quote Link to comment Share on other sites More sharing options...
Wingnut Posted January 22, 2015 Share Posted January 22, 2015 I am one of the curators? We are SO screwed! Congrats on the new documentation site, Deltakosh, Temechon, and Team! Nicely done, and thanks! And thanks for the feedback, friends. I was lucky enough to be allowed to read some of the correspondence that happened during the site's development, and I have to say that the development team worked very hard and addressed many large issues. They are still bleeding from those battles, so be developer-kind with the feedbacks, at least until the wounds have healed, and the team has gotten a shower and a meal. There are many facets to the site. Large issues were encountered and dealt-with, and I am very impressed and proud of the developer's accomplishments. AND, they managed to keep their sanity and good spirits through "the grind". Way to go, guys/gals! I have one request for the users. IF you edit a BabylonDoc (BD) document in the next 90 +/- days, it might be wise to make a home copy of the text you changed/added. I ask this NOT because I distrust the new database or its editing software, but because it IS a new database and new editing software. Stuff happens, you know. This is especially important for anyone making large edits. In general, please minimize the edits to BD documentation for a short time, and cover your butt with home copies of the documents you edit, just for general safety purposes. Save the text to home storage just before you hit the SEND button. I am MOST worried about ME making a mistake in my custodian duties, and losing somebody's edit. I will be counting-on Deltakosh to do most of the validating/rejecting of edits, especially when deep technical information is involved. I am still in-training... and will continue to be, for quite some time. Protect yourself from Wingnut's stupidity, ok? Thanks! PS: I am fairly sure that the classes documentation IS generated from the ts files, currently. Temechon and jerome 2 Quote Link to comment Share on other sites More sharing options...
GameMonetize Posted January 22, 2015 Author Share Posted January 22, 2015 Classes documentation IS generated from TS but can be updated by YOU guys jerome 1 Quote Link to comment Share on other sites More sharing options...
GameMonetize Posted January 22, 2015 Author Share Posted January 22, 2015 I meant: you can either add documentation in TS files but you can also edit documentation on the doc site (our tool will keep them for every new version) Quote Link to comment Share on other sites More sharing options...
RaananW Posted January 22, 2015 Share Posted January 22, 2015 I kind'a like the docu in the TS file, as the intellisense in the playground actually shows it. This will be a lot of work thou :-) Quote Link to comment Share on other sites More sharing options...
Recommended Posts
Join the conversation
You can post now and register later. If you have an account, sign in now to post with your account.
Note: Your post will require moderator approval before it will be visible.