Skip to content
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 broken readme links and make links relative #18

Merged
merged 3 commits into from
Dec 4, 2023

Conversation

BlacRyu
Copy link
Contributor

@BlacRyu BlacRyu commented Dec 4, 2023

Fixes #16

I also changed the local readme links to be relative instead of absolute. I'm not sure if you prefer that or not. It makes things cleaner and allows links to work automatically on forks, but I'm not sure if relative links are compatible with the generated documentation on docs.rs.

I also updated the doc links to point to latest instead of 0.1.9.

I also made a minor grammar fix on line 147.

- Fixed broken links to local repository directories.
- Minor grammar change.
- Readme links to local files or directories are now relative.
- Readme links to documentation now link to the latest version.
- Removed `/tree/main` from the relative links
@alisomay alisomay self-requested a review December 4, 2023 12:34
Copy link
Owner

@alisomay alisomay left a comment

Choose a reason for hiding this comment

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

Thanks a lot for these corrections 🌸

@alisomay alisomay self-assigned this Dec 4, 2023
@alisomay alisomay added the documentation Improvements or additions to documentation label Dec 4, 2023
@alisomay alisomay merged commit 86e58d1 into alisomay:main Dec 4, 2023
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Broken readme links
2 participants