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 user-focused documentation #110

Open
alexkreidler opened this issue Aug 25, 2020 · 2 comments
Open

Add user-focused documentation #110

alexkreidler opened this issue Aug 25, 2020 · 2 comments

Comments

@alexkreidler
Copy link

It would be great to have a user guide in the style of the Rust book or https://ballistacompute.org/docs/introduction.html, beyond what the API docs and examples provide.

@alexkreidler alexkreidler changed the title Add user-focused depth documentation Add user-focused documentation Aug 25, 2020
@alexkreidler
Copy link
Author

It would also be great to have some higher-level architecture docs describing the various internal components.

Also, it would be very helpful to list which features are supported out of these: https://ballistacompute.org/docs/reference.html.

In Rustdoc I see a whole list including Filter, LeftJoin, InnerJoin and more, but I'm not sure if those are fully implemented/supported yet.

Thanks to all for your hard work!

@alecmocatta
Copy link
Member

Thanks for checking out the project @alexkreidler!

Totally agree, Amadeus could really do with some user-oriented docs. And some docs, period :)

I've just got back from holiday and have stome stuff to catch up on but I'll work on this in the next couple weeks.

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