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

High level documentation? #443

Open
asarkar opened this issue Jul 18, 2022 · 2 comments
Open

High level documentation? #443

asarkar opened this issue Jul 18, 2022 · 2 comments

Comments

@asarkar
Copy link

asarkar commented Jul 18, 2022

README refers to hackage, hackage refers to itself, eventually, there's no usage instructions or tutorials for one to get started.

@Shimuuar Shimuuar changed the title Documentation? High level documentation? Jan 17, 2024
@Shimuuar
Copy link
Contributor

Vector does lack high level documentation. And unless someone steps up and write it it's going to stay this way. So I mark this issue as help-wanted

@AlexMaryW
Copy link
Contributor

Hi, I'd like to help out here :) just one question: what would you like the README to cover? I was thinking of some introduction, code examples/usage instructions, differentiation between vector and array.

Please note that this tutorial on Haskell Wiki is currently linked on Hackage, but maybe we could also consider linking this one? I think it's less overwhelming and more concise. It might be a bit pointless to write another tutorial just for the sake of it if there are some good and easy-to-follow tutorials already out there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants