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

Links in the documentation should not specify docs.rs path #91

Closed
brycx opened this issue Sep 3, 2019 · 3 comments
Closed

Links in the documentation should not specify docs.rs path #91

brycx opened this issue Sep 3, 2019 · 3 comments
Labels
documentation Issues and improvements sorrounding the documentation good first issue Good for newcomers improvement General improvements to code

Comments

@brycx
Copy link
Member

brycx commented Sep 3, 2019

As @vlmutolo mentioned in this issue, the current hyperlinks in the documentation all link to docs.rs.

These should be changed to follow the Rust API guidelines and not specifically link to docs.rs if the item is part of orion. This will make development easier, since the links will automatically point to locally built docs, instead of docs.rs.

The new format will probably look as follows (example taken from orion::aead, not tested to work with docs.rs):

//! [`seal`]: fn.seal.html
//! [`open`]: fn.open.html
//! [`POLY1305_OUTSIZE`]: ../hazardous/mac/poly1305/constant.POLY1305_OUTSIZE.html
//! [`XCHACHA_NONCESIZE`]: ../hazardous/stream/xchacha20/constant.XCHACHA_NONCESIZE.html
//! [`SecretKey::default()`]: struct.SecretKey.html
@brycx brycx added documentation Issues and improvements sorrounding the documentation improvement General improvements to code good first issue Good for newcomers labels Sep 3, 2019
@vlmutolo
Copy link
Contributor

vlmutolo commented Sep 4, 2019

I can take this one on. I think it’s just greping for http in the source.

@brycx
Copy link
Member Author

brycx commented Sep 19, 2019

I just found this very nice tool that we can use to check that all the links are valid: https://github.com/deadlinks/cargo-deadlinks

Maybe we should even consider adding this tool to the CI documentation build job.

@brycx
Copy link
Member Author

brycx commented Sep 22, 2019

Fixed in #100.

@brycx brycx closed this as completed Sep 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues and improvements sorrounding the documentation good first issue Good for newcomers improvement General improvements to code
Projects
None yet
Development

No branches or pull requests

2 participants