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

Make the source code easier to unserstand and discover. #36

Open
nical opened this issue May 21, 2017 · 2 comments

Comments

@nical
Copy link
Owner

commented May 21, 2017

A followup issue from discussions in #32.

Relevant comment from @Drakulix:

[...] I have a hard time to figure out what parts of it can be used in combination and how they should fit together.

[...] I don't feel like I would know where to start without studying the examples in great detail at first (which was even more difficult, before you added the new simpler example).

This could most likely be resolved by some explanation and maybe some smaller examples in the giant meta-crate. That would be the place, I would expect a gentle introduction about how to start using this project.

Looks like we need at least:

  • A "getting started" section in the documentation of the meta-crate with examples.
  • More standalone examples preferably as simple and focused as possible.
  • More detailed explanations about which crates are useful for what, which crates are optional and how the crates interact with one another.
@Drakulix

This comment has been minimized.

Copy link

commented May 23, 2017

This has improved so much with the last release. Thanks! :)

@nical

This comment has been minimized.

Copy link
Owner Author

commented May 23, 2017

You're welcome and thank you too! These improvements were made thanks to the feedback you gave. The docs are still far from perfect so don't hesitate to point me to any of its shortcomings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.