influxdata / influxdata/docs-v2

link-checker: viewing failed links requires extra click

Open
#6,393 0 comments 0 reactions 0 assignees View on GitHub
chore
Dominant language
JavaScript
Stars
82
Forks
326
Avg merge
1d 1h
Merged PRs (30d)
82

Description

When link-checker finds a broken link, the report isn't immediately viewable.
Improve the reporting:
- Regular output doesn't need to print the config - hide it in a debug flag
- Combine the error and list of links
- If possible, show details in the PR to avoid having to click to view details

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the link-checker entry point and its report-generation path. Review how regular output, configuration details, errors, and link lists are currently presented. Done means configuration is debug-only, each error is combined with its links, and PR details are shown directly where possible.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
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.