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

Link readthedocs from repo README.md #210

Open
jlapeyre opened this issue Feb 27, 2020 · 2 comments
Open

Link readthedocs from repo README.md #210

jlapeyre opened this issue Feb 27, 2020 · 2 comments
Labels

Comments

@jlapeyre
Copy link
Contributor

This would make the docs more discoverable.

@gabbyprecious
Copy link

Can you try explaining what you want achieved better, I would like to contribute on this.

@jlapeyre
Copy link
Contributor Author

jlapeyre commented Mar 3, 2020

Thanks for offering. I mean that the documents https://forest-benchmarking.readthedocs.io/en/latest/
could be linked to from within https://github.com/rigetti/forest-benchmarking/blob/master/README.md

Here is an example of how its done in the pyquil repository https://github.com/rigetti/pyquil/blame/master/README.md#L24

In fact there is a line of "badges" at the top of the README.mds. In many other repos, a badge is included that links to the documentation. Neither pyquil nor forest-benchmarking have this badge in their READMEs. But, it would be a good idea. For instance, this repo https://github.com/FluxML/Flux.jl has a badge (labeled "docs|stable") that links to its documentation.

Here is a link to the line that codes the badges in Flux.jl: https://github.com/FluxML/Flux.jl/blame/master/README.md#L5

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants