pingcap / pingcap/docs

Automatically check for broken or outdated doc links in TiDB Cloud console

Open
#20,926 0 comments 0 reactions 1 assignee View on GitHub

@shhdgit is already working on this.

Since May 9, 2025.

accessibility
Dominant language
Python
Stars
617
Forks
724
Avg merge
2d 10h
Merged PRs (30d)
223

Description

Problem: Some links (or anchor links) in TiDB Cloud console became broken or outdated, which affect user experience.

Solution: Proactively and automatically check for those broken or outdated doc links, and update them in time.

Contributor guide

Open the contributing guide

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.