babylonjs / documentation Goto Github PK

In the Virtual Joysticks section, if you click on the VirtualJoysticks example and then click on the custom joysticks example, the virtual joysticks will appear in the custom joysticks scene.

Repro (100%)

• Navigate to Input -> Virutal Joysticks
• Click on VirtualJoystick Example
• Without reloading, click on Custom Joystick Example
• Try to use the custom joysticks

The VirtualJoysticks will appear and the custom ones won't work.

https://new-doc-page.vercel.app/toolsAndResources/assetLibraries/availableMeshes

https://doc.babylonjs.com/toolsAndResources/assetLibraries/proceduralTexturesLibrary

What about displaying the pictures with their natural width/height?

I feel it's the responsibility of the one creating the doc page to create pictures with the right dimensions.

Trying to have all pictures sharing the same width is not going to work, IMO, as pictures are too different in sizes from pages to pages.

Page:
https://new-doc-page.vercel.app/divingDeeper/particles/particle_system/tuning_gradients

It is hard to read

On this page as an example: https://doc.babylonjs.com/toolsAndResources/tools/inspector

There is a medium article in the metadata that does not show up as a card in the further reading section. It should.

It's not easy to clearly see where each item starts/ends.

Maybe we can add a bullet (or something else) in front of the items:

(from Unity doc)

What's new page:

"General" is too small

To help with readability, I would recommend to set a max-width like in the old site

ala Unity: https://docs.unity3d.com/Manual/Components.html

When clicking an item in the left menu, if it has children we could automatically unfold the sub-items.

Happens in at least:

https://new-doc-page.vercel.app/divingDeeper/materials/using/masterPBR
https://new-doc-page.vercel.app/divingDeeper/materials/using/introToPBR
https://new-doc-page.vercel.app/divingDeeper/materials/using/parallaxMapping

Probably a common formating issue ?

any pages vertical mode

I tried to perform a thorough review of all the pages, clicking on all possible links (I have certainly missed some)!

I stopped at Diving Deeper -> Materials (not included) if someone wants to take over!

• https://new-doc-page.vercel.app/start/chap1/first_scene
  • not broken, but all the links in the first paragraph points to this page, don't know if it's expected
• https://new-doc-page.vercel.app/start/chap1/first_viewer
  • "Viewer" => links to the same page
  • "Example Web Page" => 404
• https://new-doc-page.vercel.app/start/chap1/first_app
  • "First App" => 404
  • "First Coded App" => 404
• https://new-doc-page.vercel.app/start/chap2/placement
  • "position" => links to the same page
  • "rotation" => 404
• https://new-doc-page.vercel.app/start/chap2/viewer2
  • "Example Viewer - Village" (2 occurrences) => 404
• https://new-doc-page.vercel.app/start/chap2/app2
  • "Example App and Instructions" (2 occurrences) => 404
• https://new-doc-page.vercel.app/start/chap3/parent
  • text "LINK TO PARENTS" is not a link
• https://new-doc-page.vercel.app/start/chap3/import_character
  • animated gif of dude deformed
• https://new-doc-page.vercel.app/divingDeeper/animation/animation_introduction
  • deformed picture of the horse
• https://new-doc-page.vercel.app/divingDeeper/animation/groupAnimations
  • "creating an animation" => 404
• https://new-doc-page.vercel.app/divingDeeper/animation/animatedCharacter
  • "ImportMesh" => points to the old doc site
  • "Action Manager" => 404
  • "Device Source Manager" => 404
  • "animation blending" => 404
• https://new-doc-page.vercel.app/divingDeeper/animation/advanced_animations
  • https://www.babylonjs-playground.com/#IQN716#9 is not handled as a PG sample
  • "Scene API documentation" => points to the old doc site
  • "Animatable" => points to the old doc site
  • "AnimationGroups" => points to the old doc site
  • "AnimationGroup" => points to the old doc site
  • "Skeleton" => points to the old doc site
  • "Animation" => points to the old doc site
• https://new-doc-page.vercel.app/divingDeeper/cameras/camera_introduction
  • "Gamepad" (2 occurrences) => 404
  • "Virtual Joysticks David Rousset Blog" => 404
  • "Using the WebVR Camera" => 404 -> also, there's an extra ";"
• https://new-doc-page.vercel.app/divingDeeper/cameras/multiViewsPart1
  • "WebGL Multiview extension" => 404
• https://new-doc-page.vercel.app/divingDeeper/cameras/layerMasksAndMultiCam
  • the text in the left menu reads "Layermasks and Multi-Cam Textures" => missing a space between Layer and masks
• https://new-doc-page.vercel.app/divingDeeper/cameras/webVRCamera
  • "WebXR camera" => points to the old doc site
  • "introduction to WebXR" => points to the old doc site
  • "WebVR Experience Helper" => 404
• https://new-doc-page.vercel.app/divingDeeper/cameras/webVRHelper
  • "WebXR experience helper" => points to the old doc site
  • "introduction to WebXR" => points to the old doc site
  • "Multiview" => 404
• https://new-doc-page.vercel.app/divingDeeper/developWithBjs/forum
  • "documentation" => points to the old doc site
• https://new-doc-page.vercel.app/divingDeeper/developWithBjs/npmSupport
  • "NPM_Support" => maybe "NPM Support" instead?
• https://new-doc-page.vercel.app/divingDeeper/developWithBjs/npmSupport#installing-other-babylon-modules
  • "the ES6 documentation" => points to the old doc site-> also, there's an extra ";"
• https://new-doc-page.vercel.app/divingDeeper/developWithBjs/howToStart
  • "here" => 404-> also, there's an extra ";"
  • "What's New" => points to the old doc site
  • http://localhost:1338/sandbox/index-local.html should be http://localhost:1338/sandbox/public/index-local.html
  • Inspector: http://localhost:1338/inspector/index.html => should we keep this link?
  • "the formatting of comments for the API" => 404
• https://new-doc-page.vercel.app/divingDeeper/developWithBjs/approvedNamingConventions
  • "documentation" => points to the old doc repo
• https://new-doc-page.vercel.app/divingDeeper/developWithBjs/usingThePlaygroundForBJSDev
  • https://github.com/BabylonJS/Babylon.js/blob/master/src/Math/babylon.math.ts => 404
  • "how to start contributing" => 404
  • "Code Guidelines" => points to the old doc site
  • "Comments in the API" => points to the old doc site
• https://new-doc-page.vercel.app/divingDeeper/developWithBjs/contributeToDocs
  • https://github.com/BabylonJS/Documentation/tree/master/content => points to the old doc repo
  • "Documentation" => points to the old doc repo
  • "Documentation/public/html/img/" => points to the old doc repo
  • "Adding new images" => points to the old doc site
• https://new-doc-page.vercel.app/divingDeeper/environment/environment_introduction
  • "here" => 404
  • "scene helpers" => 404
• https://new-doc-page.vercel.app/divingDeeper/environment/skybox
  • "library textures in the playground" => 404
• https://new-doc-page.vercel.app/divingDeeper/environment/backgroundMaterial
  • "Environment documentation" => 404
• https://new-doc-page.vercel.app/divingDeeper/environment/lenseFlare
  • broken picture for "Lens flares"
• https://new-doc-page.vercel.app/divingDeeper/environment/360VideoDome
  • "VideoTexture" => 404
• https://new-doc-page.vercel.app/divingDeeper/events/actions
  • https://www.babylonjs-playground.com/#9RUHH#5 is not handled as a PG sample
• https://new-doc-page.vercel.app/divingDeeper/events/observables
  • "GUI", "scene.onPointerObservable" => 404
  • "Observable", "Observer", "API" => point to the old doc site
  • all links under "Observable Methods and Properties" point to the old doc site
  • "Observable.add" => point to the old doc site
  • all links under "Scene Observables" point to the old doc site
  • "Interactions HowTo" => 404
• https://new-doc-page.vercel.app/divingDeeper/events/interactWithScenes
  • "GUI" => 404
• https://new-doc-page.vercel.app/divingDeeper/gui
  • "CastorGUI", "documentation" => 404
  • "dat.GUI" => wrong link
• https://new-doc-page.vercel.app/divingDeeper/gui/gui
  • "3D GUI system" => points to the old doc site
  • https://doc.babylonjs.com/features/playground_debuglayer#gui-control-actions => points to the old doc site
  • "here" (for ScrollViewer) => 404
  • "Turning AdaptToDeviceRatio Off/On" => 404
• https://new-doc-page.vercel.app/divingDeeper/gui/selector
  • Fig 1 has no picture / text
• https://new-doc-page.vercel.app/divingDeeper/gui/gui3D
  • "behaviors" => points to the old doc site
  • "2D GUI content" => points to the old doc site
  • when clicking on "Babylon 3D GUI" in the left menu, the "The Babylon GUI" entry gets also selected
• https://new-doc-page.vercel.app/divingDeeper/input/deviceSourceManager
  • "DeviceSourceManager" => points to the old doc site
• https://new-doc-page.vercel.app/divingDeeper/importers/loadingFileTypes
  • all 3 links under "Basic Usage" => 404
  • "How to Use Promises" => 404
  • "Load Files with Assets Manager" => 404
• https://new-doc-page.vercel.app/divingDeeper/importers/glTF
  • "Load from any file type" => 404
  • "properties and methods" => points to the old doc site
  • "extensions" => points to the old doc site
• https://new-doc-page.vercel.app/divingDeeper/importers/stl
  • https://github.com/BabylonJS/Babylon.js/tree/master/dist/preview => 404
  • "how to load from any file type" => 404
• https://new-doc-page.vercel.app/divingDeeper/importers/oBJ
  • https://github.com/BabylonJS/Babylon.js/tree/master/dist/preview => 404
  • "NPM support" => 404
  • "how to load from any file type" => 404
• https://new-doc-page.vercel.app/divingDeeper/importers/assetManager
  • "warning" => 404
  • picture in the "Using a loading screen" section has a broken link
• https://new-doc-page.vercel.app/divingDeeper/importers/assetContainers
  • "loading from files" => 404
• https://new-doc-page.vercel.app/divingDeeper/lights/shadows
  • https://playground.babylonjs.com/#B48X7G is not handled as a PG sample
  • "dedicated page" => 404
• https://new-doc-page.vercel.app/divingDeeper/lights/shadows_csm
  • "Shadows" => 404
  • the links 2 and 3 at the bottom of the page are not displayed correctly

Unity is making it bold + underline when selected, and underline when hover, for eg.

@deltakosh suggests "maybe we should add a link to home on the bjs logo on the left"

on: https://new-doc-page.vercel.app/divingDeeper/mesh/copies/instances

probably related to #29

so if you go there https://new-doc-page.vercel.app/advanced_topics/introToShaders
and then scroll down and click on Using ShaderMaterial the scroll bar does not go back to top
(the new page is loaded bu the scroll bar stays at the bottom)

https://new-doc-page.vercel.app/advanced_topics/webGL2

https://new-doc-page.vercel.app/divingDeeper/materials/node_material/nodeMaterial#using-the-node-material-editor

Missing pictures on the Custom Frames Section. Should match here: https://doc.babylonjs.com/how_to/node_material

Please comment in this issue if any URL from the old documentation website is not being redirect correctly to a new page in the new documentation page.

Also, maybe we should have a little less space before the bullet list starts?

https://new-doc-page.vercel.app/start

Maybe some pages don't need a TOC? Like the What's new page.

Or maybe the What's new page needs a TOC but limited to the first level, which would be the version of the engine. Else, the TOC could be very long (see again the What's new page).

So, a mechanism that would allow to tag a page as having a TOC limited to the n first levels could be handy (use n = 0 to remove the TOC).

In this page for instance:

https://new-doc-page.vercel.app/toolsAndResources/assetLibraries/postProcessLibrary/asciiArtPP
https://new-doc-page.vercel.app/toolsAndResources/assetLibraries/postProcessLibrary/digitalRainPP

Which leads to display problems:

"Original image" text is not centered.

In the old site it is ok:

As the title says.

I find it a shame that the legend takes so much space in the API pages whereas generally you don't need it.

Maybe have a way to fold/unfold it?

It would be great if the browser's address bar and status bar can go away like normal web pages when scrolling down to regain some vertical space.