docker / docker/secrets-engine
Markdown linting checks for broken internal links
Open
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 91
- Forks
- 16
- Avg merge
- 9h 3m
- Merged PRs (30d)
- 24
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.
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
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.
Assessment
- Tech stack
- markdown
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100