Skip to content

Rename navbar entries (API and Contribute)#978

Merged
TimMonko merged 2 commits intonapari:mainfrom
TimMonko:enh/shorter-navbar
Apr 9, 2026
Merged

Rename navbar entries (API and Contribute)#978
TimMonko merged 2 commits intonapari:mainfrom
TimMonko:enh/shorter-navbar

Conversation

@TimMonko
Copy link
Copy Markdown
Contributor

@TimMonko TimMonko commented Apr 8, 2026

References and relevant issues

napari/napari-sphinx-theme#200

Description

Shortens the name from "API Reference" to "API" with the hopes that this was enough to prevent the wonky navbar, however, it was not enough so we would need to modify the max-width in napari-sphinx-theme (or remove napari-hub as a link). I think from a content perspective "Reference" is redundant as a navbar name because all docs are reference material, so "API" (Reference) is implied.
It's quickly grown on me and I quite like it actually Compare how "busy" the current navbar looks on napari.org
image

Q: Should napari-hub be removed? We link to it in the plugins page, and could make that more prominent in the plugin page, or go back to linking it more prominently on the homepage.

image

And just to show a different solution that is left aligned:
image

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 8, 2026
Copy link
Copy Markdown
Contributor

@willingc willingc left a comment

Choose a reason for hiding this comment

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

Yes please! Thanks @TimMonko

@willingc willingc added the Full docs preview/ready to merge Adding this label will trigger a full docs build for previewing changes. Also @napari-bot make html label Apr 8, 2026
@TimMonko TimMonko added this to the 0.7.1 milestone Apr 8, 2026
@TimMonko
Copy link
Copy Markdown
Contributor Author

TimMonko commented Apr 8, 2026

Thanks @willingc
Another side thought (I can open an issue if this gets merged)
What about renaming Contributing -> Contribute? My gut impression is that it is more welcoming, but I know there are schools of thought on this that I'm not too caught up on

@willingc
Copy link
Copy Markdown
Contributor

willingc commented Apr 8, 2026

Makes sense to me to rename to Contribute.

Also, supported by Google's style guide: https://developers.google.com/style/headings

@TimMonko TimMonko changed the title Proposal: Rename navbar "API Reference" -> "API" Proposal: Rename navbar entries (API and Contribute) Apr 9, 2026
@TimMonko TimMonko changed the title Proposal: Rename navbar entries (API and Contribute) Rename navbar entries (API and Contribute) Apr 9, 2026
@TimMonko
Copy link
Copy Markdown
Contributor Author

TimMonko commented Apr 9, 2026

Thanks @willingc . I renamed to contribute since you were the original PR approval.

I will make a follow-up to propose removing napari-hub from the navbar, but would like to also improve the plugin index to make this a more obvious path to go to

@TimMonko
Copy link
Copy Markdown
Contributor Author

TimMonko commented Apr 9, 2026

This seems to fix napari/napari-sphinx-theme#200 now with Contributing -> Contribute as well

@TimMonko TimMonko added Full docs preview/ready to merge Adding this label will trigger a full docs build for previewing changes. Also @napari-bot make html and removed Full docs preview/ready to merge Adding this label will trigger a full docs build for previewing changes. Also @napari-bot make html labels Apr 9, 2026
@TimMonko
Copy link
Copy Markdown
Contributor Author

TimMonko commented Apr 9, 2026

@napari-bot make docs

@TimMonko
Copy link
Copy Markdown
Contributor Author

TimMonko commented Apr 9, 2026

@napari-bot make html

@TimMonko TimMonko merged commit bfe5e2c into napari:main Apr 9, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Full docs preview/ready to merge Adding this label will trigger a full docs build for previewing changes. Also @napari-bot make html

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants