search

reubenharry / haskell-docs

Creative Commons Attribution 4.0 International
59 stars 7 forks source link

Updates to Basics / Values and Types, up through the text section #11

Open cdsmith opened 1 year ago

cdsmith commented 1 year ago

Some of these changes are debatable, so I'd love to get your feedback.

netlify[bot] commented 1 year ago

Deploy Preview for haskell-docs ready!

Name Link
Latest commit 8ee6f04108fafa4523fe265412c985e8cdeefa22
Latest deploy log https://app.netlify.com/sites/haskell-docs/deploys/63c11436a3e9d10008e3157e
Deploy Preview https://deploy-preview-11--haskell-docs.netlify.app/basics/types
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

reubenharry commented 1 year ago

Thanks for doing this! Partway through reviewing (but will finish later today).

Generally, my comments are aimed at the style, in particular trying to avoid explanatory prose where possible in favour of clear examples followed by commentary (not always possible)

cdsmith commented 1 year ago

I'm going to close this while I decide what I think about contributing to documentation with copyleft licenses...

reubenharry commented 1 year ago

I'm going to close this while I decide what I think about contributing to documentation with copyleft licenses...

@cdsmith Some context: I don't know anything about licenses, and added this on the suggestion of someone on discourse: https://discourse.haskell.org/t/haskell-guide-cross-posted-on-reddit/5605/8 .

The last thing I want is to have a license which discourages anyone from contributing, so I'm more than happy to change/remove this. What would you recommend as a non-controversial choice?

reubenharry commented 1 year ago

I'm going to close this while I decide what I think about contributing to documentation with copyleft licenses...

@cdsmith Some context: I don't know anything about licenses, and added this on the suggestion of someone on discourse: https://discourse.haskell.org/t/haskell-guide-cross-posted-on-reddit/5605/8 .

The last thing I want is to have a license which discourages anyone from contributing, so I'm more than happy to change/remove this. What would you recommend as a non-controversial choice?

I replaced the copyleft license with the permissive Creative commons one for now.

reubenharry commented 1 year ago

Hi, I just wanted to check in on this PR, in the spirit of moving towards a "version 1" of this guide. I'm happy to attempt the suggested changes myself if you'd prefer.