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

Docs: Add dynamic examples for Lights #29763

Draft
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

s-rigaud
Copy link
Contributor

As meshes, geometry and bones have some good interactive examples in the documention, I think it might be great to add dynamic examples for lights too.

https://threejs.org/docs/index.html#api/en/materials/MeshLambertMaterial

https://threejs.org/docs/index.html?q=mbien#api/en/lights/AmbientLight

@s-rigaud
Copy link
Contributor Author

s-rigaud commented Oct 29, 2024

@Mugen87 @mrdoob May I have your opinion on this ? To know if I should spend more time creating examples for other types of lights or you don't think that this examples add value to the documention. Thanks :)

@s-rigaud s-rigaud changed the title Add test example for AmbientLight Docs: Add dynamic examples for Lights Oct 29, 2024
@Mugen87
Copy link
Collaborator

Mugen87 commented Oct 29, 2024

I'm not sure about this, tbh. If we go down the path and generate the docs with JSDoc, we end up with a pure API documentation (see #24984 (comment)). Things like material and geometry browser should be part of the manual then.

Also related: #27832

Because of the unclear status of the docs/manual, I can't recommend investing time in complete new parts of the documentation.

I also fear a lighting browser will be a review-heavy thing since the scene, the selected material as well as the material and light properties need to be discussed in detail. The fact that light responds differently depending on the material makes me wonder if a light browser will be more or less a second material browser (which feels redundant, imo).

@s-rigaud
Copy link
Contributor Author

In my opinion, for a someone who is not an expert of the library, it is so much useful to understand what each element provided by a library does and how it behaves. When browsing a UI library you expect to be able to see each variation of a specific component or to see the component in some context. I believe that for a library providing 3D components and objects, you should be able to browse and tests those elements. The editor is useful in this regard but a per object interactive example seems better to me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants