fix(build): Make schema description URLs linkable

build/schemas/arena-program.json

@@ -3,6 +3,7 @@
        "program":{
           "type":"object",
           "title":"Program Data",
+          "description":"Object data payload; Program config data",
           "properties":{
              "name":{
                 "type":"string",
@@ -189,4 +190,4 @@
        "type",
        "data"
     ]
- }
+ }

build/schemas/arena-scene-options.json

@@ -280,8 +280,9 @@
              "preset"
           ],
           "title":"Environment Presets",
-          "type":"object"
-       },
+          "type":"object",
+          "description":"A-Frame Environment presets. \n\nMore properties at <a href='https://github.com/supermedium/aframe-environment-component'>https://github.com/supermedium/aframe-environment-component</a>"
+          },
        "renderer-settings":{
           "properties":{
              "gammaFactor":{
@@ -331,7 +332,8 @@
              "outputEncoding"
           ],
           "title":"Renderer Settings",
-          "type":"object"
+          "type":"object",
+          "description":"These settings are fed into three.js WebGLRenderer properties"
        },
        "scene-options":{
           "properties":{
@@ -449,7 +451,8 @@
              "disableVideoCulling"
           ],
           "title":"Scene Options",
-          "type":"object"
+          "type":"object",
+          "description":"ARENA Scene Options"
        },
        "Vector3":{
           "properties":{
@@ -502,16 +505,13 @@
        "data":{
           "properties":{
              "env-presets":{
-                "$ref":"#/definitions/environment-presets",
-                "description":"A-Frame Environment presets. \n\nMore properties at https://github.com/supermedium/aframe-environment-component"
+                "$ref":"#/definitions/environment-presets"
              },
              "renderer-settings":{
-                "$ref":"#/definitions/renderer-settings",
-                "description":"These settings are fed into three.js WebGLRenderer properties"
+                "$ref":"#/definitions/renderer-settings"
              },
              "scene-options":{
-                "$ref":"#/definitions/scene-options",
-                "description":"ARENA Scene Options"
+                "$ref":"#/definitions/scene-options"
              }
           },
           "required":[

build/schemas/definitions-common.json

@@ -1,7 +1,7 @@
 {
     "properties":{
        "animation":{
-          "description":"Animate and tween values. \n\nMore properties at https://aframe.io/docs/1.3.0/components/animation.html",
+          "description":"Animate and tween values. \n\nMore properties at <a href='https://aframe.io/docs/1.3.0/components/animation.html'>https://aframe.io/docs/1.3.0/components/animation.html</a>",
           "properties":{
              "autoplay":{
                 "default":true,
@@ -201,7 +201,7 @@
           "type":"string"
        },
        "dynamic-body":{
-          "description":"Physics type attached to the object. \n\nMore properties at https://github.com/n5ro/aframe-physics-system#dynamic-body-and-static-body",
+          "description":"Physics type attached to the object. \n\nMore properties at <a href='https://github.com/n5ro/aframe-physics-system#dynamic-body-and-static-body'>https://github.com/n5ro/aframe-physics-system#dynamic-body-and-static-body</a>",
           "properties":{
              "type":{
                 "enum":[
@@ -348,7 +348,7 @@
           "default":{
              "encoding":"sRGBEncoding"
           },
-          "description": "Define extra material properties, namely texture encoding, whether to render the material's color and render order. The properties set here access directly Three.js material component. \n\nMore properties at https://threejs.org/docs/#api/en/materials/Material",
+          "description": "Define extra material properties, namely texture encoding, whether to render the material's color and render order. The properties set here access directly Three.js material component. \n\nMore properties at <a href='https://threejs.org/docs/#api/en/materials/Material'>https://threejs.org/docs/#api/en/materials/Material</a>",
           "properties":{
              "overrideSrc":{
                 "type":"string",
@@ -494,7 +494,7 @@
           }
        },
        "sound":{
-          "description":"The sound component defines the entity as a source of sound or audio. The sound component is positional and is thus affected by the component's position. \n\nMore properties at https://aframe.io/docs/1.3.0/components/sound.html",
+          "description":"The sound component defines the entity as a source of sound or audio. The sound component is positional and is thus affected by the component's position. \n\nMore properties at <a href='https://aframe.io/docs/1.3.0/components/sound.html'>https://aframe.io/docs/1.3.0/components/sound.html</a>",
           "properties":{
              "autoplay":{
                 "default":false,
@@ -577,7 +577,7 @@
           "type":"object"
        },
        "url":{
-          "description":"Model URL. Store files paths under 'store/users/<username>' (e.g. store/users/wiselab/models/factory_robot_arm/scene.gltf); to use CDN, prefix with 'https://arena-cdn.conix.io/' (e.g. https://arena-cdn.conix.io/store/users/wiselab/models/factory_robot_arm/scene.gltf)",
+          "description":"Model URL. Store files paths under 'store/users/<username>' (e.g. store/users/wiselab/models/factory_robot_arm/scene.gltf); to use CDN, prefix with `https://arena-cdn.conix.io/` (e.g. https://arena-cdn.conix.io/store/users/wiselab/models/factory_robot_arm/scene.gltf)",
           "format":"uri",
           "title":"Url",
           "type":"string"

build/schemas/definitions-geometries.json

@@ -7,7 +7,7 @@
         "type": "boolean"
       },
       "material": {
-        "description": "The material properties of the object’s surface. \n\nMore properties at https://aframe.io/docs/1.3.0/components/material.html",
+        "description": "The material properties of the object’s surface. \n\nMore properties at <a href='https://aframe.io/docs/1.3.0/components/material.html'>https://aframe.io/docs/1.3.0/components/material.html</a>",
         "properties": {
           "alphaTest": {
             "default": 0,

build/schemas/definitions-geometry.json

@@ -23,7 +23,7 @@
         "required": ["displayName"]
       },
       "material": {
-        "description": "The material properties of the object’s surface. \n\nMore properties at https://aframe.io/docs/1.3.0/components/material.html",
+        "description": "The material properties of the object’s surface. \n\nMore properties at <a href='https://aframe.io/docs/1.3.0/components/material.html'>https://aframe.io/docs/1.3.0/components/material.html</a>",
         "properties": {
           "alphaTest": {
             "default": 0,
@@ -163,7 +163,7 @@
           "encoding": "sRGBEncoding",
           "needsUpdate": false
         },
-        "description": "Define extra material properties, namely texture encoding, whether to render the material's color and render order. The properties set here access directly Three.js material component. \n\nMore properties at https://threejs.org/docs/#api/en/materials/Material",
+        "description": "Define extra material properties, namely texture encoding, whether to render the material's color and render order. The properties set here access directly Three.js material component. \n\nMore properties at <a href='https://threejs.org/docs/#api/en/materials/Material'>https://threejs.org/docs/#api/en/materials/Material</a>",
         "properties": {
           "encoding": {
             "default": "sRGBEncoding",

build/schemas/definitions-gltf.json

@@ -1,7 +1,7 @@
 {
   "properties": {
     "animation-mixer": {
-      "description": "A list of available animations can usually be found by inspecting the model file or its documentation. All animations will play by default. To play only a specific set of animations, use wildcards: animation-mixer='clip: run_*'. \n\nMore properties at https://github.com/n5ro/aframe-extras/tree/master/src/loaders#animation",
+      "description": "A list of available animations can usually be found by inspecting the model file or its documentation. All animations will play by default. To play only a specific set of animations, use wildcards: animation-mixer='clip: run_*'. \n\nMore properties at <a href='https://github.com/n5ro/aframe-extras/tree/master/src/loaders#animation'>https://github.com/n5ro/aframe-extras/tree/master/src/loaders#animation</a>",
       "properties": {
         "clampWhenFinished": {
           "default": false,

build/schemas/gltf-model.json

@@ -20,11 +20,11 @@
                                     ]
                                 },
                                 "url": {
-                                    "description": "Model URL. Dropbox share links also accepted. Store files paths under '/store/users/<username>' (e.g. store/users/wiselab/models/factory_robot_arm/scene.gltf); to use CDN, prefix with 'https://arena-cdn.conix.io/' (e.g. https://arena-cdn.conix.io/store/users/wiselab/models/factory_robot_arm/scene.gltf)",
+                                    "description": "Model URL. Dropbox share links also accepted. Store files paths under '/store/users/<username>' (e.g. store/users/wiselab/models/factory_robot_arm/scene.gltf); to use CDN, prefix with `https://arena-cdn.conix.io/` (e.g. https://arena-cdn.conix.io/store/users/wiselab/models/factory_robot_arm/scene.gltf)",
                                     "format": "uri",
                                     "title": "Url",
                                     "type": "string"
-                                }                             
+                                }
                             }
                         },
                         {
@@ -72,4 +72,4 @@
         "data",
         "persist"
     ]
-}
+}

build/schemas/image.json

@@ -21,11 +21,11 @@
                                 }
                             },
                             "url": {
-                                "description": "Model URL. Store files paths under 'store/users/<username>' (e.g. store/users/wiselab/models/factory_robot_arm/scene.gltf); to use CDN, prefix with 'https://arena-cdn.conix.io/' (e.g. https://arena-cdn.conix.io/store/users/wiselab/models/factory_robot_arm/scene.gltf)",
+                                "description": "Model URL. Store files paths under 'store/users/<username>' (e.g. store/users/wiselab/models/factory_robot_arm/scene.gltf); to use CDN, prefix with `https://arena-cdn.conix.io/` (e.g. https://arena-cdn.conix.io/store/users/wiselab/models/factory_robot_arm/scene.gltf)",
                                 "format": "uri",
                                 "title": "Url",
                                 "type": "string"
-                            }                       
+                            }
                         },
                         {
                             "$ref": "./schemas/definitions-common.json#/properties"
@@ -71,4 +71,4 @@
         "data",
         "persist"
     ]
-}
+}

build/schemas/light.json

@@ -1,6 +1,6 @@
 {
     "title": "Light",
-    "description": "A light. \n\nMore properties at https://aframe.io/docs/1.3.0/components/light.html",
+    "description": "A light. \n\nMore properties at <a href='https://aframe.io/docs/1.3.0/components/light.html'>https://aframe.io/docs/1.3.0/components/light.html</a>",
     "allOf": [
         {
             "$ref": "./schemas/definitions-arena-object.json#/properties"

build/schemas/line.json

@@ -119,4 +119,4 @@
         "data",
         "persist"
     ]
-}
+}

build/schemas/pcd-model.json

@@ -20,7 +20,7 @@
                                     ]
                                 },
                                 "url": {
-                                    "description": "Model URL. Dropbox share links also accepted. Store files paths under 'store/users/<username>' (e.g. /store/users/wiselab/pcd-models/bunny.pcd); to use CDN, prefix with 'https://arena-cdn.conix.io/' (e.g. https://arena-cdn.conix.io/store/users/wiselab/pcd-models/bunny.pcd).",
+                                    "description": "Model URL. Dropbox share links also accepted. Store files paths under 'store/users/<username>' (e.g. /store/users/wiselab/pcd-models/bunny.pcd); to use CDN, prefix with `https://arena-cdn.conix.io/` (e.g. https://arena-cdn.conix.io/store/users/wiselab/pcd-models/bunny.pcd).",
                                     "format": "uri",
                                     "title": "Url",
                                     "type": "string"
@@ -30,14 +30,14 @@
                                     "title": "Points Size",
                                     "type": "number",
                                     "default":  0.01
-                                },                                
+                                },
                                 "pointColor": {
                                     "description": "Color of the points",
                                     "title": "Points Color",
                                     "format": "color",
                                     "type": "string",
                                     "default": "#7f7f7f"
-                                }                                                                   
+                                }
                             }
                         },
                         {
@@ -88,4 +88,4 @@
         "data",
         "persist"
     ]
-}
+}

build/schemas/text.json

@@ -1,6 +1,6 @@
 {
     "title": "Text",
-    "description": "Display text. \n\nMore properties at https://aframe.io/docs/1.3.0/components/text.html",
+    "description": "Display text. \n\nMore properties at <a href='https://aframe.io/docs/1.3.0/components/text.html'>https://aframe.io/docs/1.3.0/components/text.html</a>",
     "allOf": [
         {
             "$ref": "./schemas/definitions-arena-object.json#/properties"

build/schemas/threejs-scene.json

@@ -20,11 +20,11 @@
                                     ]
                                 },
                                 "url": {
-                                    "description": "Model URL. Store files paths under 'store/users/<username>' (e.g. store/users/wiselab/models/factory_robot_arm/scene.gltf); to use CDN, prefix with 'https://arena-cdn.conix.io/' (e.g. https://arena-cdn.conix.io/store/users/wiselab/models/factory_robot_arm/scene.gltf)",
+                                    "description": "Model URL. Store files paths under 'store/users/<username>' (e.g. store/users/wiselab/models/factory_robot_arm/scene.gltf); to use CDN, prefix with `https://arena-cdn.conix.io/` (e.g. https://arena-cdn.conix.io/store/users/wiselab/models/factory_robot_arm/scene.gltf)",
                                     "format": "uri",
                                     "title": "Url",
                                     "type": "string"
-                                }                                    
+                                }
                             }
                         },
                         {
@@ -69,4 +69,4 @@
         "data",
         "persist"
     ]
-}
+}

build/schemas/triangle.json

@@ -42,7 +42,7 @@
                                         "y": -0.5,
                                         "z": 0
                                     }
-                                },                                
+                                },
                                 "vertexB": {
                                     "title": "vertex B",
                                     "properties": {
@@ -66,7 +66,7 @@
                                         "y": -0.5,
                                         "z": 0
                                     }
-                                },                                
+                                },
                                 "vertexC": {
                                     "title": "vertex C",
                                     "properties": {
@@ -90,7 +90,7 @@
                                         "y": -0.5,
                                         "z": 0
                                     }
-                                }                             
+                                }
                             }
                         },
                         {
@@ -150,4 +150,4 @@
         "data",
         "persist"
     ]
-}
+}