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

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

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

Conversation

trusktr
Copy link
Contributor

@trusktr trusktr commented Mar 30, 2025

Description

Two minor changes:

  • rename "docs" to "api" in the documentation menu
  • swap the two menu items, so that when "documentation" on the home page is clicked, the first tab will be selected.

Reasoning

Concepts like "guide" and "api reference" are both are part of overall "documentation". So it seemed fit to rename "docs" (which is the api reference) to "api".

Instead of "guide" I left "manual" alone, though personally I think "guide" is more common for this thing (guide vs api reference). I also tried the word "reference" but it was a bit long, taking up too much space in the menu alongside "manual".

"guide" + "api" is my fav, but "manual" + "api" is good too, both fit under the overall concept of "documentation" (the home page link is "documentation").

screenshots

Start with the first tab after clicking "documentation" on home page:

Screenshot 2025-03-30 at 1 15 33 PM

Then go to the API section if needed (order of tabs matches the navigation):

Screenshot 2025-03-30 at 1 15 38 PM

alternative

Here's what it looks like with "reference", which happens to match the "reference" in the sidebar (we could change that to "api" too though). Possibly we could adjust the spacing if you prefer "manual" + "reference" to make it fit better:

Screenshot 2025-03-30 at 1 22 11 PM Screenshot 2025-03-30 at 1 22 17 PM

I didn't change the folder name.

  • Rename /docs/ to /api/ too (or /reference/ if you like that more)?
  • match the sidebar title with the tab title (f.e. "api" instead of "reference" in the sidebar if the tab title is "api". but "api" and then "reference" might just make sense! read "api" "reference")

Where's the home page source? Some links are outdated on the home page (f.e. twitter -> x), and some links could be added (f.e. Bluesky, which is open source, and dev chatter is better and more active there).

This contribution is funded by Lume, 3D HTML framework

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

@Mugen87 Mugen87 Mar 30, 2025

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. Otherwise, I'll do it in the next days.

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.

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