Markdown linting checks for broken internal links

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
markdown

Research direction

The issue names only Markdown files and internal links, with no specific files, linting entry point, or tests. Start by locating the repository's Markdown checks and link-handling configuration, then define how moved or missing internal targets should be detected and verify the check against representative documentation links.

Written by the indexing model from the issue text.

Description

Internal linking between markdown files is very useful. However, it easily breaks when files get moved around. We only should do it if we automatically can check for this.

Dominant language
Go
Stars
91
Forks
16
Avg merge
9h 3m
Merged PRs (30d)
24

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.

More from docker/secrets-engine

All issues in docker/secrets-engine

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.