readthedocs / readthedocs/ext-theme

Build pop-up: show error notification if the build has failed

Open
#413 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Bug
Dominant language
HTML
Stars
12
Forks
6
Avg merge
13h 25m
Merged PRs (30d)
1

Description

I think these pop ups are cool. However, it doesn't provide too much extra useful information that the list item. The extra information it provides that's not in the list item is the commit (6225c4b5) and the build time (45 seconds). All the other data it shows in the list item:

Screenshot_2024-07-04_13-36-40

I think we can take advantage of this popup and add the reason for the build to fail here, for example. That way, users don't have to jump into the build details page to understand what happened:

Screenshot_2024-07-04_13-34-38

We could pull the error notifications and show them inside the popup. In this particular case, it would show: No HTML content found -- No content was output to the path "$READTHEDOCS_OUTPUT/html". Read more about where to put your built files.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the build pop-up and the source of build error notifications. Update the pop-up so failed builds display the relevant error reason and its accompanying guidance, rather than requiring users to open the build details page. Done means the failure message shown in the issue appears in the pop-up.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.