three.js icon indicating copy to clipboard operation
three.js copied to clipboard

"Officialize" renaming of examples classes to addons

Open LeviPesin opened this issue 3 years ago • 6 comments

Related issue: https://github.com/mrdoob/three.js/pull/23406

Description

As we now have three/addons alias, and started to refer to examples classes as addons, isn't it the time to note that in documentation?

LeviPesin avatar Sep 01 '22 19:09 LeviPesin

I think fundamentals.html in new manual are missing the information about import maps...

LeviPesin avatar Sep 06 '22 19:09 LeviPesin

Renaming the doc pages will break a lot of URLs. Without implementing a redirect, I do not vote for doing this.

Besides, the PR got too complex. The first changes to the Installation guide were fine but now it's really hard to review everything. I suggest to revert and implement changes more incrementally.

Mugen87 avatar Sep 07 '22 07:09 Mugen87

I tried to git revert commits but that seems to broke everything...

LeviPesin avatar Sep 07 '22 19:09 LeviPesin

Okay, I fixed it somehow 🙏

LeviPesin avatar Sep 07 '22 19:09 LeviPesin

Besides, the PR got too complex. The first changes to the Installation guide were fine but now it's really hard to review everything. I suggest to revert and implement changes more incrementally.

Reverted those changes.

LeviPesin avatar Sep 08 '22 17:09 LeviPesin

@LeviPesin it might be better to open an issue for this first to see if there is support for the change, and also to figure out exactly what is required.

I'm personally in favor but as @Mugen87 points out it has to happen without breaking URLs. Which might make this more complicated than it first appears. On the other hand maybe it's ok just to change the docs and page titles and leave URLs as they are?

looeee avatar Sep 08 '22 22:09 looeee

Hey, I believe this can be merged 👍

marcofugaro avatar Oct 10 '22 14:10 marcofugaro