-
Notifications
You must be signed in to change notification settings - Fork 2.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix format and add links for contribute.md #10232
base: main
Are you sure you want to change the base?
fix format and add links for contribute.md #10232
Conversation
Reviewer's Guide by SourceryThis pull request enhances the contributing documentation by adding direct links to relevant resources such as the FAQ, issue tracker, discussions, and Discord server. It also improves the formatting of notes within the documentation for better readability by using HTML tags. No diagrams generated as the changes look simple and do not need a visual representation. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @pierceroberts - I've reviewed your changes - here's some feedback:
Overall Comments:
- The added
<ins>
tags don't seem necessary and may not render as intended in all contexts. - Consider whether the links should be absolute or relative for better maintainability.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @pierceroberts - I've reviewed your changes - here's some feedback:
Overall Comments:
- The added
<ins>
tags don't seem to render correctly on GitHub; consider using a different formatting approach for the notes. - It might be worth checking how the links render on the live site to ensure they are working as expected.
Here's what I looked at during the review
- 🟡 General issues: 1 issue found
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
or [Discord]. | ||
* **Check the [FAQ](faq.md)** for a list of common questions and problems. | ||
* **Check the [blog](https://python-poetry.org/blog/)** for release notes from recent releases, including steps for upgrading and known issues. | ||
* **Check that your issue does not already exist** in the [issue tracker]( https://github.com/python-poetry/poetry/issues). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue (typo): Extra space in issue tracker link.
There's an extra space before the URL for the issue tracker. Please remove it.
* **Check that your issue does not already exist** in the [issue tracker]( https://github.com/python-poetry/poetry/issues). | |
* **Check that your issue does not already exist** in the [issue tracker](https://github.com/python-poetry/poetry/issues). |
So the As for the links I was simply making them work and cleaning up the inconsistencies. There were some that went to links and some that just went to the bottom. And it made more sense to have one way. |
I think you are on the wrong track. The files in the docs folder are not optimized for being viewed via github but for generating our documentation. |
Oh interesting.... |
The source code is here: https://github.com/python-poetry/website See https://github.com/python-poetry/website?tab=readme-ov-file#local-development |
Pull Request Check List
Resolves: #issue-number-here
Summary by Sourcery
This PR fixes relative links and updates external resources to use absolute links in
contributing.md
.Documentation:
contributing.md
.contributing.md
to use absolute links for external resources.