purescript/documentation

Move guides to libraries where appropriate

hdgarrood opened this issue · 7 comments

hdgarrood commented

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 commented

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

hdgarrood commented

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

hdgarrood commented

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 commented

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 commented

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

hdgarrood commented

I don't think so, please do!

hdgarrood commented

Everyone listed above is now in CONTRIBUTORS.md 🎉

  • 🎉1