Skip to content

Conversation

Mugen87
Copy link
Collaborator

@Mugen87 Mugen87 commented Apr 3, 2025

Related issue: -

Description

The PR adds the following section to doc pages:

image

We had this in place for the old docs and it seems it was a helpful feature for users. The only problem is we can't generate the section automatically since addons are not imported in a uniform fashion. E.g.

import { OrbitControls } from 'three/addons/controls/OrbitControls.js';
import GLSLDecoder from 'three/addons/transpiler/GLSLDecoder.js';
import * as BufferGeometryUtils from 'three/addons/utils/BufferGeometryUtils.js';

So the idea is to use a custom tag @three_import to classes and modules which documents the import. If we agree on that, I can file a follow-up PR updating all addons.

@mrdoob
Copy link
Owner

mrdoob commented Apr 3, 2025

That sounds good to me 👌

@Mugen87 Mugen87 added this to the r176 milestone Apr 4, 2025
@Mugen87 Mugen87 merged commit b076a7e into mrdoob:dev Apr 4, 2025
11 checks passed
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