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

Add link to the generated documentation to often-seen readmes #2709

Closed
wants to merge 1 commit into from

Conversation

seritools
Copy link
Contributor

@seritools seritools commented Nov 18, 2023

Just a tiny bit of friction I hit sometimes - there's actually no link to the generated documentation inside the readmes, and thus no easy way to get to the docs from GitHub either. The only link I can find is in the sidebar on crates.io. Usually googling (or hoping it's in the browser history) seems to be faster than finding it that way.

This PR just adds it to the main readme file, and to the readme for the windows crate itself.

@ChrisDenton
Copy link
Collaborator

ChrisDenton commented Nov 19, 2023

Adding a link in the readme of the windows crate makes some sense to me as it's at an unusual address. I'm less sure about adding it to docs/readme.md as that's meant to be an overview of all crates.

@kennykerr
Copy link
Collaborator

There's also a link on crates.io for each crate, so this doesn't seem all that valuable. I try to keep the readmes as uncluttered as possible, so I'm reluctant to add convenience links like this.

@seritools
Copy link
Contributor Author

sounds good

@seritools seritools closed this Nov 20, 2023
@seritools seritools deleted the patch-1 branch November 20, 2023 18:49
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.

3 participants