JabRef / JabRef/user-documentation
Add automated check for "broken-reference"
Open
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 54
- Forks
- 142
- Avg merge
- 23h 56m
- Merged PRs (30d)
- 12
Description
When cleaing up image names, uploaded images are merged - and marked as "broken"
dc7d8308e775cca7bfe8b046229e869594cf8e81
There should be a check for figure><img src="broken-reference" alt=""> inside .md files to see if images are missing.
Refs https://github.com/JabRef/user-documentation/issues/527
Contributor guide
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
Review commit dc7d8308e775cca7bfe8b046229e869594cf8e81 and issue #527, then inspect the repository's .md files for the shown broken-reference pattern. Identify the existing automation entry point, if any, and make the check report missing images; done means this pattern is detected in Markdown files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100