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

Move guides to libraries where appropriate #96

Closed
4 tasks done
hdgarrood opened this issue Jul 3, 2017 · 7 comments
Closed
4 tasks done

Move guides to libraries where appropriate #96

hdgarrood opened this issue Jul 3, 2017 · 7 comments

Comments

@hdgarrood
Copy link
Collaborator

hdgarrood commented Jul 3, 2017

I think some guides would probably be easier to find if they were put in the docs for the relevant libraries. For example:

  • The Partial type class -> purescript-partial
  • QuickCheck -> purescript-quickcheck
  • Eff -> purescript-eff (actually moved to purescript-effect)
  • Generic -> purescript-generics-rep

I also think they'd be less likely to go out of date, as you're more likely to remember to update guides like this if they're right there when you're changing the code.

What do people think?

@paf31
Copy link
Contributor

paf31 commented Jul 3, 2017

Aside from the license issue we discussed, I think it's a great idea.

@hdgarrood
Copy link
Collaborator Author

I'll check the git history to get a list of contributors to those.

@hdgarrood
Copy link
Collaborator Author

hdgarrood commented Jul 3, 2017

I think this is complete. I've done my best to go back through the histories in both this repo and the website one:

Partial: hdgarrood
QuickCheck: paf31, hdgarrood, soupi
Eff: paf31, shuhei, narrative, mseri, owickstrom, kritzcreek
Generic: paf31, hdgarrood, kika

@paf31
Copy link
Contributor

paf31 commented Jul 6, 2017

Also kika on the generics one.

Seems like eff will be the trickiest one, but the others should be simple enough to deal with. I think we need a CONTRIBUTORS.md file going forward, until we can get to the point where we can add a LICENSE file.

@anttih
Copy link
Contributor

anttih commented Jul 17, 2018

Is anything stopping us from moving this forward? If not, I'll create the PRs in the library repos.

@hdgarrood
Copy link
Collaborator Author

I don't think so, please do!

@hdgarrood
Copy link
Collaborator Author

Everyone listed above is now in CONTRIBUTORS.md 🎉

hdgarrood added a commit that referenced this issue Jan 27, 2019
hdgarrood added a commit that referenced this issue Jan 27, 2019
hdgarrood added a commit that referenced this issue Feb 4, 2019
Link to the purescript-partial library instead, which is where the guide
now lives.
hdgarrood added a commit that referenced this issue Feb 4, 2019
Link to the purescript-partial library instead, which is where the guide
now lives.

I've kept this page for now instead of removing it completely, because
the compiler's Prim docs page still links to it as of 0.12.2 (see:
<https://pursuit.purescript.org/builtins/docs/Prim#t:Partial>)
hdgarrood added a commit that referenced this issue Feb 5, 2019
Link to the purescript-partial library instead, which is where the guide
now lives.

I've kept this page for now instead of removing it completely, because
the compiler's Prim docs page still links to it as of 0.12.2 (see:
<https://pursuit.purescript.org/builtins/docs/Prim#t:Partial>)
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

3 participants