JuliaDiff / JuliaDiff/BlueStyle
Automatically test for broken links in README.md
Open
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 519
- Forks
- 34
- PR merge metrics
- No merged PRs in 30d
Description
https://github.com/invenia/BlueStyle/pull/67 showed that we had broken links in the README.
Perhaps we could use Documenter to run linkcheck on the README somehow?
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
Read the linked pull request #67 to see which README links were broken, then check Documenter’s linkcheck support and how it could be run against README.md. Done means an automated check detects broken links in the README.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation, testing
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100