Coder Social home page Coder Social logo

Comments (5)

reubenharry avatar reubenharry commented on July 30, 2024 1

Definitely, although note the existence of this excellent guide: https://lhbg-book.link/

from haskell-docs.

reubenharry avatar reubenharry commented on July 30, 2024

Good idea. I'd definitely be willing (in fact very happy) to include this information if you contribute it. Currently, there is some hint of this info, although it isn't at all detailed. See here: https://haskell-docs.netlify.app/gettingstarted/versions/#installing-packages .

There is also a project in the repo, which could be used as a reference (and updated to follow best practices). One approach you could take would be to heavily comment the .cabal file from that project, and then import it into the markdown, and add more info beneath it. I've done something similar for haskell files, e.g. at https://haskell-docs.netlify.app/casestudy/chess/ , so that might fit nicely into the structure of the guide. Another (possibly compatible) option might be to add an FAQ on "What is the difference between stack and cabal". But if you have other ideas, that's cool too of course.

Another comment is that I generally have tried in general in the guide to not state information explicitly if I think a user is likely to figure it out easily. So e.g. I personally might not spend a lot of time on the difference between a library and an executable, beyond what a newcomer would likely be confused by.

In the spirit of avoiding overwhelming the user with information, I also chose to only discuss cabal and mention stack only in passing in the Getting Started sections, because a newcomer is unlikely to care about the difference, and choosing cabal means there's one less new word to learn (since I'll need to mention cabal either way). You can see a comment in this vein at the bottom of this section: https://haskell-docs.netlify.app/gettingstarted/versions/?h=stack#managing-software . But mentioning stack more elsewhere in the guide seems fine, so I defer to your judgment.

from haskell-docs.

lsmor avatar lsmor commented on July 30, 2024

Ok, with this feedback I'll write a first sketch and work from there ;)

from haskell-docs.

dangdennis avatar dangdennis commented on July 30, 2024

Would a section for web development be considered a case study?

from haskell-docs.

dangdennis avatar dangdennis commented on July 30, 2024

Thanks for the share! Going through the guide myself 😄

from haskell-docs.

Related Issues (17)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.