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.

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

Draft: Flyout: Build status indicator #446

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

ericholscher
Copy link
Member

@ericholscher ericholscher commented Nov 21, 2024

Do a very basic build status indictor,
which shows the status of the current/last build.

I couldn't get it to center vertically for some reason,
but just wanted to throw something up as a starting point.

Example

Screenshot 2024-11-21 at 3 25 59 PM

Do a very basic build status indictor,
which shows the status of the current/last build.
@agjohnson
Copy link
Contributor

Don't stop exploring addons and JS, but I do think we should discuss this feature first.

This will show failed build state to all reader users. That seems bad for large projects and commercial users, where reader users most likely don't know what Read the Docs or a failed build is. A failed state, red circle, or describing the build as failed all seem like things we should only throw at maintainers.

I'd say the flyout is the wrong place to surface this, and this would make more sense in a dedicated PR build UI. This might be the same UI as diffing too.

@humitos
Copy link
Member

humitos commented Nov 26, 2024

Don't stop exploring addons and JS, but I do think we should discuss this feature first.

I agree on this. We touched on this idea in a previous issue but we found we need to do something else regarding caching: #88

I'd say the flyout is the wrong place to surface this, and this would make more sense in a dedicated PR build UI. This might be the same UI as diffing too.

We talked about maybe adding an indicator on the notification.


I think we are entering on the phase where we would get a lot of benefit from discussing "what are the next steps regarding addons UI" as soon as possible. We all want to implement more addons features, but nobody feels comfortable about where to put them. Building these features will be pretty quick once we define that.

@ericholscher
Copy link
Member Author

I agree on this. We touched on this idea in a previous issue but we found we need to do something else regarding caching: #88

This is useful context. I see we already noted in that issue that we'll want to hit the API directly for this data to avoid caching, which makes a lot of sense 👍

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.

3 participants