Skip to content

rename 'docs' to 'api' in the docs menu #30826

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.

Sign up for GitHub

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

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

rename 'docs' to 'api' in the docs menu #30826

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
<h1><a href="https://threejs.org">three.js</a></h1>

<div id="sections">
<span class="selected">docs</span>
<a href="../manual/">manual</a>
<span class="selected">api</span>
</div>

<div id="expandButton"></div>
Expand Down Expand Up @@ -97,7 +97,7 @@ <h1><a href="https://threejs.org">three.js</a></h1>

// Redirect to the manual

window.location.href = hash.replace(/^manual\/([^\/]+)\/([^\/]+)\/(.+)$/, '../manual/#$1/$3').toLowerCase();
window.location.href = hash.replace( /^manual\/([^\/]+)\/([^\/]+)\/(.+)$/, '../manual/#$1/$3' ).toLowerCase();

}

Expand Down
2 changes: 1 addition & 1 deletion manual/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@
<h1><a href="https://threejs.org">three.js</a></h1>

<div id="sections">
<a href="../docs/">docs</a>
<span class="selected">manual</span>
<a href="../docs/">api</a>
</div>

<div id="expandButton"></div>
Expand Down
4 changes: 2 additions & 2 deletions utils/docs/template/tmpl/layout.tmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
<h1><a href="https://threejs.org">three.js</a></h1>

<div id="sections">
<span class="selected">docs</span>
<a href="/examples/#webgl_animation_keyframes">examples</a>
<span class="selected">docs (is this used? it doesn't match the new menu)</span>
<a href="/examples/#webgl_animation_keyframes">examples (is this used? it doesn't match the new menu)</a>
</div>
Comment on lines +34 to 35
Copy link
Collaborator

@Mugen87 Mugen87 Mar 30, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

(is this used? it doesn't match the new menu

Yes, this is used in the new documentation based on JSDoc. The file has not been updated with the new navigation (manual/docs), yet. Feel free to do that in your PR.

FYI: The new docs based on JSDoc will replace the old docs next release. We originally wanted to publish the new docs with r175. However, some additional style updates are required, see #30774 (comment). We head now for r176.

Copy link
Contributor Author

@trusktr trusktr Apr 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Ah in that case yeah I need to figure out how to build and preview the JSDoc version of the site to update the PR.

I keep fumbling when navigating to the current docs:

Before:

  • click on "documentation" on the home page
  • start searching to lookup an API doc
  • click to view (done)

Currently:

  • click on "documentation" on the home page
  • start typing, but then realize the API I'm looking for is not found
  • realize that's because we're landing on the Manual by default now
  • click over to the "docs"
  • start searching again to look up an API doc
  • click to view (done)

I keep doing this. I'm always wanting to go straight to the search bar to filter for API reference docs. I don't think the Manual will get this same type of usage as often.

<div id="expandButton"></div>
</div>
Expand Down