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 small intro/pointer to docs site in crate documentation #21

Open
Skirmisher opened this issue May 26, 2021 · 3 comments
Open

Add small intro/pointer to docs site in crate documentation #21

Skirmisher opened this issue May 26, 2021 · 3 comments

Comments

@Skirmisher
Copy link

Having no introduction in the top-level crate documentation is not a very nice experience :( Since the docs site introduces the API nicely in the "guides" section, it would be prudent to include a small welcome message that points people there.

@tasn
Copy link
Member

tasn commented May 26, 2021

We would happily merge a PR that adds this. Wanna add one?

@Skirmisher
Copy link
Author

I might have an opportunity to at some point, but I created this issue to suggest a mitigation for something that discourages potential users, which might be easily added by a maintainer (in lieu of a full introduction with examples), since I was not in a position to do so immediately.

@tasn
Copy link
Member

tasn commented May 26, 2021

Yeah, I understand! Just saying that this sounds like something that should be easy enough to add, and we would be happy to accept a PR for. Sure, we can do this ourselves, but it's better to get people (especially the originator of the idea) involved. :)

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

No branches or pull requests

2 participants