Repair broken links in CONTRIBUTING.md#1881
Conversation
Links now reference appropriate files in the /docs directory.
|
|
Overall Grade |
Security Reliability Complexity Hygiene |
Code Review Summary
| Analyzer | Status | Updated (UTC) | Details |
|---|---|---|---|
| Python | Mar 9, 2026 7:45p.m. | Review ↗ | |
| Test coverage | Mar 9, 2026 7:45p.m. | Review ↗ |
|
Hey @bartejam , thanks for opening this! These changes work when I build the docs locally from your fork, but the when I build them locally with main checked out the links also work, as do the deployed ones at https://plantcv.readthedocs.io/en/stable/CONTRIBUTING/ and the versions in the readme in this repo so I may be looking in the wrong place for the error you mention in #1880. Could you clarify where you're getting the 404 error? |
|
Hello @joshqsumner! Thanks for looking at my PR. The links are only broken from the repo home page with the tabbed readme/code of conduct/contributor guide/license at the bottom. As you discovered, they work fine everywhere else. |
|
Thanks @bartejam , I see now! I don't think I've ever noticed those tabs actually. Good catch! |
joshqsumner
left a comment
There was a problem hiding this comment.
@nfahlgren , the bug this addresses only causes an issue in the tabs on the readme of the github repo presumably because those are looking in the root directory for the linked files. Locally building them these changes worked in everything that I was able to check.
This seems like a way more succinct fix than messing with a more complicated readme or whatever the other options could be.
Describe your changes
A number of links on the contributor tab on the repo main page were producing 404 errors. Repaired links now reference appropriate files in the /docs directory.
Type of update
Update to documentation
Associated issues
#1880
Additional context
No further context.
For the reviewer
See this page for instructions on how to review the pull request.
plantcv/mkdocs.ymlupdating.md