Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for add-on content #27034

Open
omerKamran2 opened this issue Oct 23, 2023 · 3 comments
Open

Documentation for add-on content #27034

omerKamran2 opened this issue Oct 23, 2023 · 3 comments

Comments

@omerKamran2
Copy link

omerKamran2 commented Oct 23, 2023

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.

@omerKamran2 omerKamran2 changed the title Documentation for add-on content Documentation for addon content Oct 23, 2023
@omerKamran2 omerKamran2 changed the title Documentation for addon content Documentation for add-on content Oct 23, 2023
@CodyJasonBennett
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

Relates to #25381

Mugen87 pushed a commit that referenced this issue Sep 10, 2024
* Docs: Document the examples/jsm/lines components. (#27034, #29353)

* Docs: Link from LineBasicMaterial.linewidth to LineMaterial.
LD2Studio pushed a commit to LD2Studio/LD2Studio-Editor that referenced this issue Sep 13, 2024
* Docs: Document the examples/jsm/lines components. (mrdoob#27034, mrdoob#29353)

* Docs: Link from LineBasicMaterial.linewidth to LineMaterial.
LD2Studio pushed a commit to LD2Studio/LD2Studio-Editor that referenced this issue Sep 13, 2024
* Docs: Document the examples/jsm/lines components. (mrdoob#27034, mrdoob#29353)

* Docs: Link from LineBasicMaterial.linewidth to LineMaterial.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants