Jump to content

Contributing to documentation 101


GameMonetize
 Share

Recommended Posts

Thanks, but looking in that public/ img directory, there is a file, flight_arcade.jpg.  A tutorial ends up in a tutorials directory on the website.  If img was a subdirectory of tutorial when published, then this would not get a 404, http://doc.babylonjs.com/tutorials/img/flight_arcade.jpg.

So is this grunt thing going to do the fix up to where it really is?

FYI, I PRed without a image, and moved on.  The image I was going to do, is of the Encode window of the PVRTexTool.  I am hoping it is going to be improved for WebGL, so I'll wait.

Link to comment
Share on other sites

  • 2 weeks later...
  • 2 weeks later...

I'm happy to see that my tutorial about raycasts is now online, thx to Deltakosh and RaananW :

http://doc.babylonjs.com/tutorials/raycasts

So now the questions about that on the forum will be lighten and people can have directly the answers on the Documentation.

_____

I have some other ideas for improving existing tutorials. I don't know if I'll do it or someone else :

 

- Collision system :  precisions on ellipsoid dimensions, talk about oncollide    

(new features to add : draw ellipsoid, onGrounded variable and slope factor maybe)
 

- Animating bones : talking about the new features of 2.5 rotating bones, blending, playing animation only on certain bones

(new features to add : importing multiples animation from different action and timeline in Blender ?)

 

Link to comment
Share on other sites

  • 4 months later...

Hi, first timer here. I've followed the instructions for creating a new tutorial, but I seem to be havimg a problem with grunt. I used the --force parameter and this was the result:

/Documentation$ grunt build --force
Running "clean:json" (clean) task
>> 0 paths cleaned.

Running "execute:compileTagsClasses" (execute) task
-> executing module /Documentation/scripts/compile-tags/com
pile-tags-classes.js

Error: not a function
Warning: Task "execute:compileTagsClasses" failed. Used --force, continuing.

Running "execute:createListClasses" (execute) task
-> module call undefined
Warning: Cannot find module 'meta-marked' Used --force, continuing.

Running "execute:compileIndex" (execute) task
-> executing module /Documentation/scripts/compile-html/com
pile-html-index.js

Error: not a function
Warning: Task "execute:compileIndex" failed. Used --force, continuing.

Running "execute:compileWhatsNew" (execute) task
-> executing module /Documentation/scripts/compile-html/compile-html-index.js

Error: not a function
Warning: Task "execute:compileIndex" failed. Used --force, continuing.

Running "execute:compileWhatsNew" (execute) task
-> executing module /Documentation/scripts/compile-html/com
pile-html-whats-new.js

Error: not a function
Warning: Task "execute:compileWhatsNew" failed. Used --force, continuing.

Running "execute:compileHtmlClasses" (execute) task
-> module call undefined
Warning: Cannot find module 'async' Used --force, continuing.

Running "execute:compileHtmlStatics" (execute) task
-> module call undefined
Warning: Cannot find module 'async' Used --force, continuing.

Running "execute:forwarder" (execute) task
-> module call undefined
Warning: Cannot find module 'meta-marked' Used --force, continuing.

Running "clean:indexes" (clean) task
>> 0 paths cleaned.

Running "execute:indexer" (execute) task
-> module call undefined
Warning: Cannot find module 'async' Used --force, continuing.

Running "clean:tmp" (clean) task
>> 0 paths cleaned.

Done, but with warnings.


Execution Time (2017-06-28 11:17:20 UTC+2)
loading tasks               203ms  ▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 71%
clean:json                   42ms  ▇▇▇▇▇▇▇▇ 15%
execute:compileTagsClasses    9ms  ▇▇ 3%
execute:createListClasses     3ms  ▇ 1%
execute:compileIndex          3ms  ▇ 1%
execute:compileWhatsNew       5ms  ▇ 2%
execute:compileHtmlClasses    4ms  ▇ 1%
execute:compileHtmlStatics    3ms  ▇ 1%
execute:forwarder             3ms  ▇ 1%
execute:indexer               3ms  ▇ 1%
clean:tmp                     4ms  ▇ 1%
Total 284ms

Maybe the problem is with my grunt setup? 

/Documentation$ grunt -V
grunt-cli v1.2.0
grunt v0.4.5

 

Link to comment
Share on other sites

 

BTW, this is what changed after adding my stuff and installing grunt:

diff --git a/data/statics.json b/data/statics.json
index 35caf27..1073f04 100644
--- a/data/statics.json
+++ b/data/statics.json
@@ -171,6 +171,10 @@
         {
           "title": "Multi-Platform Compressed Textures",
           "filename": "Multi-Platform_Compressed_Textures"
+        },^M
+        {^M
+          "title": "BabylonJS in an Ionic Angular app",^M
+          "filename": "BabylonJS_and_Ionic_Angular"^M
         }
       ]
     },
diff --git a/package.json b/package.json
index 8e52d94..ecba2bd 100644
--- a/package.json
+++ b/package.json
@@ -34,13 +34,13 @@
     "grunt-contrib-sass": "^0.9.2",
     "grunt-contrib-watch": "^0.6.1",
     "grunt-execute": "^0.2.2",
-    "grunt-express-server": "~0.4.2",
+    "grunt-express-server": "^0.4.19",
     "grunt-open": "^0.2.3",

 

Link to comment
Share on other sites

Little question about new page for Blender exporter doc'. As you can see, I've created dead links: http://doc.babylonjs.com/exporters/blender/features/cameras.html :ph34r:

But I'm not sure about how to tweak statics.json.

I've added a new folder features in /exporters/Blender/, and it could be great if this folder can be a subfolder.

For now in statics.json we have:

{
  "title": "Blender",
  "name": "Blender",
  "img": "img/exporters/Blender.jpg",
  "desc": "Learn how to export from Blender",
  "files": [
    {
      "title": "Blender",
      "filename": "Blender"
    },
    {
      "title": "Blender tips",
      "filename": "Blender_Tips"
    },
    {
      "title": "Installing the Babylon Exporter",
      "filename": "Installing__the_Babylon_Exporter"
    },
    {
      "title": "Working with Blender",
      "filename": "Working_with_Blender"
    }
  ]
},

Could I modify this file like this, or am I totally wrong ? :D

{
  "title": "Blender",
  "name": "Blender",
  "img": "img/exporters/Blender.jpg",
  "desc": "Learn how to export from Blender",
  "files": [
    {
      "title": "Blender",
      "filename": "Blender"
    },
    {
      "title": "Blender features",
      "files": [
      	{
      		"title": "Cameras",
      		"filename": "cameras"
      	},
      	{
      		"title": "World",
      		"filename": "world"
      	},
      ]
    },
    {
      "title": "Blender tips",
      "filename": "Blender_Tips"
    },
    {
      "title": "Installing the Babylon Exporter",
      "filename": "Installing__the_Babylon_Exporter"
    },
    {
      "title": "Working with Blender",
      "filename": "Working_with_Blender"
    }
  ]
},

 

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...