Skip to content

README URLs use absolute links to fix crates.io dead URLs#494

Open
jnomikos wants to merge 1 commit into
mavlink:masterfrom
jnomikos:readme-fix
Open

README URLs use absolute links to fix crates.io dead URLs#494
jnomikos wants to merge 1 commit into
mavlink:masterfrom
jnomikos:readme-fix

Conversation

@jnomikos
Copy link
Copy Markdown

The URLs in the crates.io page (https://crates.io/crates/mavlink) pointing to this repository do not work.

e.g "See mavlink/examples/ for runnable examples." gives the URL https://github.com/mavlink/rust-mavlink/blob/HEAD/mavlink/mavlink/examples/ which is wrong.

So, I replaced the URLs to be absolute URLs instead.

Comment thread README.md
Comment on lines -128 to +139
See [`mavlink/examples/`](mavlink/examples/) for runnable examples.
See [`mavlink/examples/`](https://github.com/mavlink/rust-mavlink/tree/master/mavlink/examples) for runnable examples.

## Maintainers

See [MAINTAINERS.md](MAINTAINERS.md) for active maintainers, release managers and contact details.
See [MAINTAINERS.md](https://github.com/mavlink/rust-mavlink/blob/master/MAINTAINERS.md) for active maintainers, release managers and contact details.

## License

Licensed under either of:

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) at your option.
- Apache License, Version 2.0 ([LICENSE-APACHE](https://github.com/mavlink/rust-mavlink/blob/master/LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license ([LICENSE-MIT](https://github.com/mavlink/rust-mavlink/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT) at your option.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

With this approach, even if you click on them from a different branch they will redirect you to the master branch.

I wonder if there's a better fix.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

There might be a better way. I'll take a look at how other crates do it

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants