Skip to content

Give the guide some content #81

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

Closed
fitzgen opened this issue May 10, 2019 · 2 comments · Fixed by #86
Closed

Give the guide some content #81

fitzgen opened this issue May 10, 2019 · 2 comments · Fixed by #86
Labels
docs Related to documentation and the guide enhancement New feature or request

Comments

@fitzgen
Copy link
Member

fitzgen commented May 10, 2019

The guide is pretty much empty. It should have something in it.


Straw proposal:

This would get us a good amount of documentation in all the places users expect it to be, without multiplying the maintenance effort.

Thoughts?


+cc @David-OConnor @Pauan @yoshuawuyts @rylev

@fitzgen fitzgen added enhancement New feature or request docs Related to documentation and the guide labels May 10, 2019
@fitzgen fitzgen added this to the 0.1 initial release milestone May 10, 2019
@Pauan
Copy link
Contributor

Pauan commented May 10, 2019

That sounds fine to me. I agree that the guide's contents should probably match with the crate's docs.

@David-OConnor
Copy link
Member

The current crates are fairly straightforward, and are easy to understand from the comments in code and examples. The guide will be more relevant once complex, interacting crates are included.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to documentation and the guide enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants