NatLabRockies / NatLabRockies/SAM
Fix broken URLs in Help
Open
Beginner friendly
Nobody has claimed this yet.
bug
- Dominant language
- C++
- Stars
- 486
- Forks
- 219
- Avg merge
- 10h 10m
- Merged PRs (30d)
- 2
Description
That there are many broken links in Help that need to be fixed.
From /SAM/doc/source, run sphinx-build -b linkcheck . _build/linkcheck to generate report of broken links using the linkcheck builder.
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
From /SAM/doc/source, run sphinx-build -b linkcheck . _build/linkcheck to generate the broken-link report. Review the reported URLs in the Help documentation and fix them, then rerun the linkcheck builder; done means the broken links in Help are resolved.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100