etebase-rs icon indicating copy to clipboard operation
etebase-rs copied to clipboard

Add small intro/pointer to docs site in crate documentation

Open Skirmisher opened this issue 3 years ago • 3 comments

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.

Skirmisher avatar May 26 '21 04:05 Skirmisher

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

tasn avatar May 26 '21 07:05 tasn

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.

Skirmisher avatar May 26 '21 07:05 Skirmisher

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. :)

tasn avatar May 26 '21 09:05 tasn