Comments (5)
Definitely, although note the existence of this excellent guide: https://lhbg-book.link/
from haskell-docs.
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.
Ok, with this feedback I'll write a first sketch and work from there ;)
from haskell-docs.
Would a section for web development be considered a case study?
from haskell-docs.
Thanks for the share! Going through the guide myself 😄
from haskell-docs.
Related Issues (17)
- Add a comment system HOT 1
- Show how to read Hackage type class summary
- Add a more principled editing process
- Set up CI for the Haskell project to compile
- Add `foldl` and `Writer` to Gotchas
- Discuss more packages
- Full case study, with good code examples HOT 2
- Regarding the target audience of the tutorial HOT 4
- Online code playground HOT 2
- Code checking and running HOT 2
- Make GHC version clear
- Social cards
- Include the website link inside the repo's about section
- feature request: release code under a software-friendly license HOT 2
- Broken link for performance guide HOT 3
- "Edit this page" link is broken HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from haskell-docs.