Skip to content

Conversation

@nothing-991
Copy link

Fixes a broken reference link in development documentation by replacing
the dead SmartBear PDF with the current article URL.

@nothing-991
Copy link
Author

Hi @ichard26 / maintainers
I fixed the broken link in docs/html/development/contributing.rst by replacing the outdated PDF URL with the current SmartBear page for peer code review best practices.
I also verified that all checks are now passing.
Please let me know if you’d like me to update any additional links in the development docs. Thanks!

Copy link
Member

@ichard26 ichard26 left a comment

Choose a reason for hiding this comment

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

Thanks!

The publisher seems to have updated the best practices a bit comparing to the archived PDF on the Wayback Machine, but it still looks relevant.

@ichard26
Copy link
Member

ichard26 commented Jan 1, 2026

@nothing-991 If you'd like, you can try your hand at fixing all of the links in the development folder. They all seem not too bad to fix.

@nothing-991
Copy link
Author

Hi @ichard26, thanks!
I checked the links in the development folder and so far the only broken one I found was the archived PDF link, which I’ve fixed in this PR.
The remaining links appear to be working for me, but I’m happy to re-check or fix any specific ones you had in mind.

@ichard26
Copy link
Member

ichard26 commented Jan 3, 2026

I'd included a list of all broken links in the original issue. Here are the remaining links in the development folder:

  • (development/getting-started: line 204) broken https://docs.gitlab.com/ee/gitlab-basics/start-using-git.html - 403 Client Error: Forbidden for url: https://gitlab.com/users/sign_in
  • (development/getting-started: line 94) broken https://docs.pytest.org/en/latest/usage.html#specifying-tests-selecting-tests - Anchor 'specifying-tests-selecting-tests' not found
  • (development/architecture/overview: line 119) broken https://warehouse.readthedocs.io/api-reference/legacy/#simple-project-api - Anchor 'simple-project-api' not found

@nothing-991
Copy link
Author

Thanks for the detailed list 🙌

I've fixed the remaining broken links in the development docs:

  • Replaced the GitLab link that returned a 403
  • Updated the pytest usage link to a valid page
  • Fixed the warehouse legacy API link by removing the broken anchor

Please let me know if you’d prefer a different target for any of these links.

.. _`open an issue`: https://github.com/pypa/pip/issues/new?title=Trouble+with+pip+development+environment
.. _`install Python`: https://realpython.com/installing-python/
.. _`rich CLI`: https://docs.pytest.org/en/latest/usage.html#specifying-tests-selecting-tests
.. _`rich CLI`: https://docs.pytest.org/en/latest/how-to/usage.html
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
.. _`rich CLI`: https://docs.pytest.org/en/latest/how-to/usage.html
.. _`rich CLI`: https://docs.pytest.org/en/latest/how-to/usage.html#specifying-which-tests-to-run

@nothing-991
Copy link
Author

hey @ichard26,
All the changes are done in the Development folder as you Suggested. Please let me know,
If you want any further Changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants