-
-
Notifications
You must be signed in to change notification settings - Fork 35.4k
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
Comments
FYI I introduced |
I believe only the most common addons are documented: But yeah a lot of them are missing, if you find some addon without a documentation page feel free to make a PR!
@CodyJasonBennett hmm not sure if we want to use the 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. |
Relates to #25381 |
* Docs: Document the examples/jsm/lines components. (mrdoob#27034, mrdoob#29353) * Docs: Link from LineBasicMaterial.linewidth to LineMaterial.
* Docs: Document the examples/jsm/lines components. (mrdoob#27034, mrdoob#29353) * Docs: Link from LineBasicMaterial.linewidth to LineMaterial.
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.
The text was updated successfully, but these errors were encountered: