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

docs: fix dead links in README.md #1856

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rebustron
Copy link

Description

Hi! I fixed outdated and incorrect paths in README.md, ensuring all internal links point to the correct locations.

Changes:

Checklists

All Submissions:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

New Features:

  • I've added tests for the new feature
  • I've added docs for the new feature

Bugfixes:

  • This pull request breaks the existing API
  • I've added tests to reproduce the issue which are now passing
  • I'm linking the issue being fixed by this PR

Copy link
Contributor

@ValuedMammal ValuedMammal left a comment

Choose a reason for hiding this comment

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

Thank you @rebustron

ACK a245814

Note also that it is preferable to conform to conventional commits style.

@ValuedMammal ValuedMammal added this to the 1.2.0 milestone Feb 25, 2025
@ValuedMammal ValuedMammal added the documentation Improvements or additions to documentation label Feb 25, 2025
Copy link
Contributor

@oleonardolima oleonardolima left a comment

Choose a reason for hiding this comment

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

ACK a245814

@oleonardolima oleonardolima mentioned this pull request Mar 3, 2025
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
Status: Needs Review
Development

Successfully merging this pull request may close these issues.

3 participants