Brand New Documentation!

Hey Everyone,

As a part of the Babylon.js 4.2 launch today we are SUPER excited to unveil our brand new, completely overhauled documentation pages:

We rethought our approach a bit…shifting the docs from a “choose-your-own-adventure” teaching style, to a “Chapter Book” approach.

It’s our hope that this new design and architecture will make it easier for people who are brand new to Babylon and don’t know where to get started. However we also didn’t want to sacrifice the ability for seasoned developers to find what they want to learn about quickly. We hope this new design does both.

If you would please all check out the new docs and let us know what you think, we’d greatly appreciate it.

And with all software, expect there to be a few rough edges that need polishing. If you find anything that seems odd, please let us know here in this thread. The new docs are propagating to servers across the world now, so if you still see the old docs, try again in 30 mins or so.

We also want to take a moment and publicly thank @JohnK, who’s incredible passion for teaching has fueled this massive project to success. John from the bottom of our hears we thank you. We truly could not have done this massive project without you!

Also a giant THANK YOU to @RaananW as well, who literally built the new doc system for us. Raanan you are a truly gifted developer!

Enjoy the new docs everyone!

27 Likes

Thanks a lot @RaananW / @PirateJC and @JohnK

You did a really impressive work! The new menu on the left is a game changer

6 Likes

The list of examples on the right of each page is also a killer feature!

3 Likes

Congrats all who take part on this great job!

Woaw, this new documentation is awesome. You did a wonderful job.
I like this menu on the left and the examples on the right.
The code of the pages is more readable.
Thanks to the team, especially @JohnK and @RaananW and all those who participated

PS: The text may be slightly small. Increasing it from 1 to 2 px might be good.

3 Likes

I just realized that when we copy the code on the pages to paste it locally, the code is separated one word by line.

exemple : (Copy then paste here give this result)

Résumé
function

CustomLoadingScreen
(

/* variables needed, for example:*/
text
)

{

//init the loader

this
.
loadingUIText

=
text
;
}
CustomLoadingScreen
.
prototype
.
displayLoadingUI

=

function
(
)

{

alert
(
this
.
loadingUIText
)
;
}
;
CustomLoadingScreen
.
prototype
.
hideLoadingUI

=

function
(
)

{

alert
(
“Loaded!”
)
;
}
;

2 Likes

@Dad72 awesome catch! Fixing it now!

2 Likes

Fixed, thanks a lot

5 Likes

Great work! Well organised & professionally presented. Great to have examples inline as well as in sidebar and to have API docs at the same URL / under the docs umbrella.

One minor layout issue I noticed is that code blocks aren’t indented correctly e.g.

Looks amaizing! Also found interseting flickering, I think you would like to know.

1 Like

We are translating babylon’s tutorial to Chinese. New Documentation has changed a lot from the previous content, and we are now very troubled! :sleeping: :sleeping: :sleeping:

Yes I really like the new documentation.
My only issue is that on a small screen (laptop) when reading the API the pane with the relevant info is small. The legend takes up a lot of screen space and I couldn’t see how to hide or shrink it.
Anyway, that is a minor point and I think it is great. I am new to Babylon and have just had a bit of breathing space to have a look around (beyond my immeadiate needs) and discovering all sorts of wonderful features I didn’t know about.
Thanks to everyone involved.

1 Like

What can I say. I can say this part of the upgrade was, in my opinion, THE MOST IMPORTANT for Babylon’s future.
In fact, looking at the old version (let’s forget about it;), I was about to offer you my services/contribution in this aspect:( #com. I can see you don’t need me for that;) I’m sure I will have comments though… I always do;) but this will only be after I had enough time to explore this HUGE update of yours. @com team: @RaananW @JohnK @PirateJC GJ really and I mean it 100%.

2 Likes

And the doc website is now available in china! And should be very fast according to the tests i’ve made (i18n DNS/CDN tests). Let me know if it isn’t!!

Yeah, I heard this one already. I am going to minimize the legend somehow! makes a lot of sense

First, thanks for this great comment, and second - bring’em on! We want to make the site as good as we can, so any comments/issues are more than welcomed. The site is open source, and on github, and we welcome issues gladly!

2 Likes

Yes! the speed is very fast, Will the content of the future documents be greatly changed? We still have to do a lot of translation work. Or is the official Chinese document considered?

1 Like