Jump to content

2.3 class api documentation


satguru
 Share

Recommended Posts

I also have a question. How often quoted the documentation 'extension' is updated.
I send a PR for the extension CastorGUI there 23 days, it has been validated, but is not updated on the site. There is for example a file I add to the doc, which is present on the deposit, but not on the site.

Link to comment
Share on other sites

As I made the GUIColor.md add a doc that is present in the gitHub. but it is not present on the site.

On the deposit can be seen GUIColor file (the 4 th file in the list)

https://github.com/BabylonJS/Documentation/tree/master/content/extensions/CastorGUI

But on the site, the file does not exist.

http://doc.babylonjs.com/extensions

Is what I miss something?

Link to comment
Share on other sites

On 28/2/2016 at 7:09 PM, satguru said:

Compare  the description of PointLight in 2.2 and 2.3 below

http://doc.babylonjs.com/classes/2.2/PointLight

http://doc.babylonjs.com/classes/2.3/PointLight

You will see that in 2.3 the description is empty

Bug found! I now try to fix it.... It's a meta-marked problem we had some weeks ago, which force us to add spaces after each '#' character on the .md files. So, the old .md parsing is now broken.

Link to comment
Share on other sites

On 28/2/2016 at 2:09 PM, satguru said:

Compare  the description of PointLight in 2.2 and 2.3 below

http://doc.babylonjs.com/classes/2.2/PointLight

http://doc.babylonjs.com/classes/2.3/PointLight

You will see that in 2.3 the description is empty

According to satguru links, you can look at the class description and see that some links (<a> tags) are missing in 2.3 version

Link to comment
Share on other sites

On March 1, 2016 at 2:09 AM, Jaskar said:

Bug found! I now try to fix it.... It's a meta-marked problem we had some weeks ago, which force us to add spaces after each '#' character on the .md files. So, the old .md parsing is now broken.

Wow I need to do some research what you just said sounded like gobbly gook and that's not good.  Is this a git thing? I would like on understand what's being discussed here, could someone explain for us laimens? 

Link to comment
Share on other sites

@Pryme8 : Nop, it's not a git things.
The documentation works like this : We have a script that "build" the documentation html pages, from markdown files. These md files are build from Babylon definition file, and previous version files.

This script use some node modules, as a md file parser. This parser, called "meta-marked", had an update some weeks ago, so we needed to add some spaces after each '#' character on the .md files. But this change broke some other functions.

 

Hope I was clear :)

Link to comment
Share on other sites

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.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

Loading...
 Share

  • Recently Browsing   0 members

    • No registered users viewing this page.
×
×
  • Create New...