Move man page README.md to full links #483
Conversation
Reviewer's Guide by SourceryThe PR updates the man page links in the README.md file from relative paths to full GitHub URLs to ensure proper display on PyPi project site. 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
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @rhatdan - I've reviewed your changes - here's some feedback:
Overall Comments:
- The path to ramalama-info.1.md appears inconsistent with other man pages - it's not in the docs/ directory like the others. Consider moving it to docs/ for consistency.
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.
README.md
Outdated
| | [ramalama-version(1)](docs/ramalama-version.1.md) | display version of AI Model | | ||
| | [ramalama(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama.1.md) | primary RamaLama man page | | ||
| | [ramalama-containers(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-containers.1.md)| list all RamaLama containers | | ||
| | [ramalama-info(1)](https://github.com/containers/ramalama/blob/main/ramalama-info.1.md) | display RamaLama configuration information | |
There was a problem hiding this comment.
suggestion: The ramalama-info.1.md file appears to be in the root directory instead of the docs directory
Consider moving ramalama-info.1.md to the docs directory to maintain consistency with the documentation structure of other commands
| [ramalama-info(1)](https://github.com/containers/ramalama/blob/main/docs/ramalama-info.1.md) | display RamaLama configuration information |
There was a problem hiding this comment.
A decent suggestion from the bot this time, noticed this one was missing /docs
There was a problem hiding this comment.
Thank you for your feedback, we will generate more comments like this in the future according to the following instructions:
- Ensure the comment provides a clear suggestion for improvement or correction.
- The comment should address consistency or organization issues within the project structure.
- Include specific examples or references to support the suggestion.
- The comment should be constructive and aim to enhance the overall quality of the project.
There was a problem hiding this comment.
Nice catch, it has found a couple of other suggestions to be fixed. I like it.
There was a problem hiding this comment.
Thank you for your feedback, we will generate more comments like this in the future according to the following instructions:
- Ensure the comment provides a clear suggestion for improving the organization or structure of the code or documentation.
- The comment should include a rationale for the suggestion, explaining why the change would be beneficial.
- The comment should reference specific files or sections of the codebase to provide context.
- The comment should be constructive and aim to enhance consistency or maintainability.
There was a problem hiding this comment.
This is something that would only be found when someone reports the bug.
This should fix the issue that man pages are not showing up on the PyPi project site. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
This should fix the issue that man pages are not showing up on the PyPi project site.
Summary by Sourcery
Documentation: