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.

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

Jump to bottom

Add release notes and community chat links to homepage sidebar #610

Merged
merged 3 commits into from
Mar 9, 2025
Merged

Add release notes and community chat links to homepage sidebar #610

merged 3 commits into from
Mar 9, 2025

Conversation

TimMonko
Copy link
Contributor

@TimMonko TimMonko commented Mar 2, 2025 •
edited
Loading

References and relevant issues

Closes #601

Description

Adds two links to the homepage sidebar

  1. community chat (I find it a bit hidden under More)
  2. release notes landing page (is there a way we could instead use current release notes link?)
    • the first commit works properly to link to the index
    • the second commit attempts to dynamically link to the current release notes, can fall back to first commit if this isn't worth getting right. I think right now it would 404 for any rc/a/b/post?

@TimMonko TimMonko marked this pull request as ready for review March 2, 2025 20:54
@TimMonko
Copy link
Contributor Author

TimMonko commented Mar 2, 2025

Hmm, realizing there is already a square for the community page (which contains zulip) on the main page AND the footer has the zulip link.

I still struggle to find it sometimes, and this feels like a nice place for a it anyways. Happy to remove and just add the release notes link

@TimMonko TimMonko changed the title rename sidebar links file; add chat and release notes Add release notes and community chat links to homepage sidebar Mar 2, 2025
willingc
willingc reviewed Mar 2, 2025
View reviewed changes
docs/_templates/sidebar-link-items.html
@@ -0,0 +1,19 @@
<nav class="bd-docs-nav bd-links">
Copy link
Contributor

Choose a reason for hiding this comment

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

I think making this change in the napari-sphinx-theme is likely a better place for these changes.

Copy link
Member

Choose a reason for hiding this comment

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

Either way would be fine - I understand @TimMonko' s argument about these links being specific to our pages but we have a bunch of napari-specific items in the theme as well 🤷🏻

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 3, 2025
willingc
willingc approved these changes Mar 3, 2025
View reviewed changes
Copy link
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.

Approving as this works now. We can move the templates to the napari-sphinx-theme in the future. Thanks @TimMonko

@willingc
Copy link
Contributor

willingc commented Mar 3, 2025

@melissawm @psobolewskiPhD This would be a nice PR to land before 0.6.0.

@TimMonko
Copy link
Contributor Author

TimMonko commented Mar 4, 2025

Thanks Carol. Why do you think it's good to move to the theme? I guess at least other sites which use the theme would benefit from these relatively generic links. I guess it would be weird if a non core-napari project used this sidebar.

To be quite honest, I'm not sure why it uses this special template compared to the other TOCS sidebars, but I didn't want to rewrite something that someone clearly got working before me

@melissawm
Copy link
Member

Thanks Carol. Why do you think it's good to move to the theme? I guess at least other sites which use the theme would benefit from these relatively generic links. I guess it would be weird if a non core-napari project used this sidebar.

To be quite honest, I'm not sure why it uses this special template compared to the other TOCS sidebars, but I didn't want to rewrite something that someone clearly got working before me

The short answer is that the landing page is a special page, in that its children are listed in the top navbar and not the sidebar. So to add items to the sidebar, we need to use templates (see https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/layout.html#primary-sidebar-left for some docs on this)

melissawm
melissawm approved these changes Mar 5, 2025
View reviewed changes
Copy link
Member

@melissawm melissawm left a comment

Choose a reason for hiding this comment

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

LGTM, thank you @TimMonko !

@melissawm melissawm added this to the 0.6.0 milestone Mar 8, 2025
psobolewskiPhD
psobolewskiPhD approved these changes Mar 8, 2025
View reviewed changes
Copy link
Member

@psobolewskiPhD psobolewskiPhD left a comment

Choose a reason for hiding this comment

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

Looks fine to me.
I will make a followup issue to consider if we want to add anything else to this sidebar location.

@psobolewskiPhD psobolewskiPhD mentioned this pull request Mar 8, 2025
Closed
@TimMonko
Copy link
Contributor Author

TimMonko commented Mar 8, 2025

The short answer is that the landing page is a special page, in that its children are listed in the top navbar and not the sidebar. So to add items to the sidebar, we need to use templates (see pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/layout.html#primary-sidebar-left for some docs on this)

Thank you for this extra information! Very helpful :)

@TimMonko TimMonko mentioned this pull request Mar 9, 2025
Closed
@DragaDoncila DragaDoncila merged commit 77b85f9 into napari:main Mar 9, 2025
9 checks passed
@TimMonko TimMonko mentioned this pull request Mar 12, 2025
Merged
jni pushed a commit that referenced this pull request Mar 14, 2025
@TimMonko
Move links out of navbar and into sidebar / other docs. (#620)
12ac953 
# References and relevant issues

Closes #615. Follow up of #610. Remake of #617 because I got confused
with the commit history and merging

# Description

I think the navbar is a bit too cluttered due to the 'More' section
being propagated to the sidebar in smaller width screens (and generally
being finnicky)

1. Moves 3 lower-value (I still love them) links out of the navbar:
blog, zulip chat, and workshop template
2. Moves blog to homepage sidebar (confirms there is a link to blog in
community)
3. Moves workshop template link to Workshops page in Usage, also adds a
link to Contributing index
4. Removes zulip link in favor of presence in homepage sidebar and
presence in footer. If we want to keep this in header we should move the
footer link up to the header in theme
5. Adds troubleshooting link to homepage sidebar (**check** that this is
internally referenced correctly, I can't do
https://napari.org/troubleshooting.html/ like I can for other internal
refs, it 404s)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@willingc willingc willingc approved these changes

@melissawm melissawm melissawm approved these changes

@psobolewskiPhD psobolewskiPhD psobolewskiPhD approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.6.0
Development

Successfully merging this pull request may close these issues.

Add release notes link to the homepage
5 participants
@TimMonko @willingc @melissawm @psobolewskiPhD @DragaDoncila