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

Extended documentation / examples #286

Open
beyarkay opened this issue Mar 29, 2022 · 3 comments
Open

Extended documentation / examples #286

beyarkay opened this issue Mar 29, 2022 · 3 comments

Comments

@beyarkay
Copy link

Love the crate, busy using it for some visualization work for strange attractors. Just want to see if @emoon is open to me adding to the documentation / examples or if there's a particular style they want for them?

I see there are some example scripts, but was thinking about adding references to them so they're more discoverable and adding some more in-line examples to the docs.

If this would be appreciated then I'll get started on it.

@emoon
Copy link
Owner

emoon commented Mar 29, 2022

Hey! Thanks! :)

That sounds great. What might be possible to do is to add another README.md to the examples directory, add screenshots for each example with some description to each. Then of course it would be possible to add more of them if wanted as well. The general docs could perhaps have an example section or so (or link to the example readme)

I'm open for suggestions here.

@beyarkay
Copy link
Author

Okay cool, I like the idea of an examples/README.md for screenshots and then linking to that from the main README/docs. I'll probably end up adding inline comments to the examples as well.

@emoon
Copy link
Owner

emoon commented Dec 28, 2022

Hey, any progress on this issue?

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