rename 'docs' to 'api' in the docs menu #30826
Open
+5
−5
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Two minor changes:
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:
Then go to the API section if needed (order of tabs matches the navigation):
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:
I didn't change the folder name.
/docs/
to/api/
too (or/reference/
if you like that more)?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