search

mrdoob / three.js

JavaScript 3D Library.
https://threejs.org/
MIT License
101.98k stars 35.33k forks source link

Documentation for add-on content #27034

Open omerKamran2 opened 11 months ago

omerKamran2 commented 11 months ago

Description

Hello, Three.js community,

I'd like to request your input and guidance on the addition of documentation for addon features under the path: three/examples/jsm/. I noticed that most of the add-on stuff isn't documented.

Solution

Perhaps I can create a fork and get started on the documentation and others can pitch in? I believe that having comprehensive documentation for these feature would be a valuable addition to the Three.js docs.

Also, before I begin the documentation process, I wanted to confirm if anyone in the community is already working on documenting this feature or if there are existing open pull requests related to it. I'd like to avoid duplicating efforts. If there are specific guidelines, formatting requirements, or style preferences for contributing to the Three.js documentation, please let me know. I want to ensure that the documentation aligns seamlessly with the official documentation.

CodyJasonBennett commented 11 months ago

FYI I introduced three/addons just now in #26910 where you can import { GLTFLoader } from 'three/addons' which is not yet documented. I wonder if this can be used in example code also with the use of the newly supported import maps.

marcofugaro commented 11 months ago

I'd like to request your input and guidance on the addition of documentation for addon features under the path: three/examples/jsm/. I noticed that most of the add-on stuff isn't documented.

I believe only the most common addons are documented:

image

But yeah a lot of them are missing, if you find some addon without a documentation page feel free to make a PR!

I wonder if this can be used in example code also with the use of the newly supported import maps.

@CodyJasonBennett hmm not sure if we want to use the three/addons import in the examples, since in the plain ES modules environment there would be tons of requests to every addon. However we're already doing that for the nodes examples, so I'm not sure.

But I agree, it should be documented, the right place would be the Addons section of the installation guide, specifying to use it only if you're using a bundler.

AxiomeCG commented 11 months ago

Relates to #25381