readthedocs / readthedocs/ext-theme

Link to error line on build output page

Open
#74 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Build detail page command listing already has anchors for all of the lines and commands. We could add a helper to jump to the command/line that errored out, as sometimes users don't seem to scroll down on the page.

Also worth noting that some old builds have not super helpful error messages, which are just the last failed command output. These specifically could use this feature instead, though hopefully views of old builds aren't frequently viewed.

  • Add an element to jump to the errored command or command line on the build detail page
  • Same, but in the error notification? I don't know if we want to get into Knockout inside notifications though.

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 at the build detail page's command listing and inspect the existing anchors for lines and commands. Add a way to jump to the command or line associated with the error; decide separately whether the error notification is in scope, and verify the link lands at the failed output.

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.