Skip to content

Auto generate release index with highlights and timeline - #838

Merged
TimMonko merged 19 commits into
napari:mainfrom
TimMonko:auto-highlights
Sep 16, 2025
Merged

TimMonko merged 19 commits into
napari:mainfrom
TimMonko:auto-highlights

Conversation

@TimMonko

@TimMonko TimMonko commented Sep 12, 2025 •

Copy link
Copy Markdown
Member

Description

This PR auto-generates a nifty index page for release notes. In my experience, release notes are one of the most enticing things to read, and made especially more so when I get to be presented with something cool (like a timeline, "what I missed", etc). This tries to do a few things that to me are very compelling:

  1. Uses our highlights to make compelling quick reads
  2. Uses dropdowns to make a user feel more in control of the otherwise lengthy file
  3. Its much more searchable than multiple files in terms of highlights. (i.e. I can search "Labels" and find relevant release highlights)
  4. Includes a frame of reference for time, which is often very hard to comprehend as someone who is not following on top of all the releases. Helps much more with the "whats changed since I've last used napari"

I accomplish this by:

  1. autogenerating index.md for releases with update_release_docs.py
  2. hook this in with our stub system, to reduce build time. this does build in about a second though, so I'm not sure this is needed? just being consistent with other files I used as examples its hooked up to stubs, but is currently set to always generate because it seriously takes minimal time. I'm open to whatever we think is best for this
  3. changes the sidebar link to always link to this nifty page, rather than the meh experience that is current when clicking on latest release note.

I made this because I was procrastinating a demo, but I really wanted to make it much easier for past napari users to "catch up" outside of us having to pick out all the pieces in our demo.

image

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 12, 2025
@TimMonko TimMonko added this to the 0.6.5 milestone Sep 12, 2025
@TimMonko TimMonko added the highlight highlight this PR in release notes label Sep 12, 2025
@TimMonko

Copy link
Copy Markdown
Member Author

I added the highlight label because I think this is worth showing to people / having them be able to share with others more easily.

@jni jni left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I haven't looked at the code in detail, but the proof is in the pudding, and the pudding is friggin delicious! 😂

One thought I had is that we could get the release date from PyPI instead of trying to parse it. But maybe this is worse since it doesn't seem to be a problem for any recent releases, and we autogenerate the date now, and currently the script doesn't need to use any remote APIs which is nice.

@jni jni 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 Sep 16, 2025
@TimMonko

Copy link
Copy Markdown
Member Author

One thought I had is that we could get the release date from PyPI instead of trying to parse it. But maybe this is worse since it doesn't seem to be a problem for any recent releases, and we autogenerate the date now, and currently the script doesn't need to use any remote APIs which is nice.

Yes, I thought about this too! My conclusion was the no remote is nice -- less likely to flake on CI.
Agreed, these can be follow-ups.

Draga also gave this a look over in person, so I'm gong to merge.

@TimMonko
TimMonko merged commit de45b5a into napari:main Sep 16, 2025
12 checks passed
@github-actions github-actions Bot removed 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 Sep 16, 2025
TimMonko added a commit that referenced this pull request Sep 22, 2025
# References and relevant issues

After #838 building docs locally will update the release index
[#working-group-documentation > autogenerate release summary doc #838 @
💬](https://napari.zulipchat.com/#narrow/channel/298358-working-group-documentation/topic/autogenerate.20release.20summary.20doc.20.23838/near/540614480)

# Description

Adds file to gitignore so that changes aren't bothersome locally
@brisvag brisvag mentioned this pull request Sep 26, 2025
@imagesc-bot

Copy link
Copy Markdown

This pull request has been mentioned on Image.sc Forum. There might be relevant details there:

https://forum.image.sc/t/napari-v0-6-5-is-out/116715/1

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 highlight highlight this PR in release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants