Skip to content

Conversation

Mugen87
Copy link
Collaborator

@Mugen87 Mugen87 commented Mar 14, 2025

Related issue: -

Description

Before switching to the new docs, I suggest to move the "manual" part of the current documentation to https://threejs.org/manual/. This looks like so:

image

In this way, there is a clear separation. https://threejs.org/manual/ represents the manual with guides and in-depth articles whereas https://threejs.org/docs/ represents the API documentation.

Next step:

We can delete all contents in /docs and remove it from git versioning. /docs will then be the output directory of JSDoc.

text = text.replace( /\[example:([\w\_]+) ([\w\:\/\.\-\_ \s]+)\]/gi, '<a href="../../examples/#$1" target="_blank">$2</a>' ); // [example:name title]
text = text.replace( /\`(.*?)\`/gs, '<code class="notranslate" translate="no">$1</code>' ); // `code`

document.body.innerHTML = text;
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to enhance lesson.js so certain things like link definitions don't had to be changed.

However, it was no copy/paste of manual pages since code sections and links to the doc pages had to be changed.

@Mugen87 Mugen87 added this to the r175 milestone Mar 17, 2025
@Mugen87 Mugen87 merged commit d808e37 into mrdoob:dev Mar 17, 2025
11 checks passed
This was referenced Mar 18, 2025
@mrdoob
Copy link
Owner

mrdoob commented Mar 28, 2025

Fixed the broken links: 49f25c6

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