Skip to content

Repair broken links in CONTRIBUTING.md#1881

Open
bartejam wants to merge 3 commits into
danforthcenter:mainfrom
bartejam:repair-broken-contributor-guide-links
Open

Repair broken links in CONTRIBUTING.md#1881
bartejam wants to merge 3 commits into
danforthcenter:mainfrom
bartejam:repair-broken-contributor-guide-links

Conversation

@bartejam
Copy link
Copy Markdown

@bartejam bartejam commented Feb 19, 2026

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.

  • PR functionality reviewed in a Jupyter Notebook
  • All tests pass
  • Test coverage remains 100%
  • Documentation tested
  • New documentation pages added to plantcv/mkdocs.yml
  • Changes to function input/output signatures added to updating.md
  • Code reviewed
  • PR approved

Links now reference appropriate files in the /docs directory.
@deepsource-io
Copy link
Copy Markdown

deepsource-io Bot commented Feb 19, 2026

DeepSource Code Review

We reviewed changes in 12eb31d...52e6342 on this pull request. Below is the summary for the review, and you can see the individual issues we found as inline review comments.

See full review on DeepSource ↗

PR Report Card

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 ↗

@joshqsumner
Copy link
Copy Markdown
Contributor

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?

@bartejam
Copy link
Copy Markdown
Author

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.

@joshqsumner
Copy link
Copy Markdown
Contributor

Thanks @bartejam , I see now! I don't think I've ever noticed those tabs actually. Good catch!

@joshqsumner joshqsumner self-requested a review February 24, 2026 20:56
Copy link
Copy Markdown
Contributor

@joshqsumner joshqsumner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

@joshqsumner joshqsumner added contributor Adding a new contributor documentation Documentation issues or features labels Feb 24, 2026
@nfahlgren nfahlgren added this to the PlantCV v4.10.3 milestone Feb 24, 2026
@github-project-automation github-project-automation Bot moved this to Pull Requests in PlantCV4 Feb 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contributor Adding a new contributor documentation Documentation issues or features

Projects

Status: Pull Requests

Development

Successfully merging this pull request may close these issues.

4 participants