Skip to content

feat: add release badges to doc status badges#975

Open
stevenle wants to merge 4 commits intomainfrom
feat/docs-status-releases
Open

feat: add release badges to doc status badges#975
stevenle wants to merge 4 commits intomainfrom
feat/docs-status-releases

Conversation

@stevenle
Copy link
Member

"pending releases" are cached via a context provider, when the doc status badges are rendered, it uses the cached values to prevent repeated db calls.

screenshots:

Screenshot 2026-03-21 at 9 11 26 AM Screenshot 2026-03-21 at 9 18 34 AM

fixes #568

@jeremydw
Copy link
Member

LGTM

One note - a doc could be in multiple releases technically. I wonder if we should make the badge just say "Release" and a popover that contains the release names, description, and a link to the releases?

@stevenle
Copy link
Member Author

i'd like to keep the href within the badge itself since it's always tricky for me to have on-hover tooltips/menus that disappear if you're trying to rollover to it but took an unfavorable path causing the popover to disappear.

so two options:

1 - keep it as is (show a badge for each release, each clickable to to its respective release details page)
2 - show the message "N releases" with a tooltip that lists the ids, and when user clicks on it, it goes to a filtered version of the release list page which shows only the releases the doc is in

@jeremydw
Copy link
Member

Let's go with either of your preferences for now - (1) seems simplest so sgtm and we can revise later

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.

Add releases to doc status badges

2 participants