readthedocs / readthedocs/ext-theme
Misleading error message when importing project with non-existing repository
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 12
- Forks
- 6
- Avg merge
- 13h 25m
- Merged PRs (30d)
- 1
Description
I found that, when importing a project that doesn't exist, the process continues as usual but the following error message is shown:
Could not add webhook for sphinx-tutorial-astrojuanlu. Make sure you have the correct GitHub permissions.
The project sphinx-tutorial-astrojuanlu doesn't have a valid webhook set up, commits won't trigger new builds for this project. See the project integrations for more information.
I ended up in this situation because my list of repositories included one that I had deleted earlier. But, if the user doesn't click "refresh", this is not detected.
Even though the refresh logic stays the same, I think showing a better error message in this (admittedly rare) case would help.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the project-import flow and the webhook error handling described in the issue. Reproduce the case with a deleted repository, then verify that the displayed error distinguishes a missing repository from invalid GitHub permissions without changing the refresh behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, html
- Domain
- frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100