Cookbook?
- Dominant language
- Haskell
- Stars
- 1.7k
- Forks
- 750
- Avg merge
- 4d 3h
- Merged PRs (30d)
- 28
Description
It would be v good to have some common use scenarios drawn out in the documentation. (I'd offer to help, but don't have enough knowledge to do so reliably.) For example:
* it would be good to have an upfront explanation of the hierarchy of basic concepts and how they inter-relate: environment (in various flavours: ghc package , project, etc), profile, project, cabal package, package, library, executable, test, ... global v local v user, tabulating the differences between v1 and v2
* Basic use case: building an executable from hackage (trivial)
* Including a hackage library in a project that you are developing (trivial)
* Including a local version of a library in a package that you are developing that is not on hackage
* Including a local version of a library in a package that you are developing that is also on hackage
* packages that have both libraries and exes and tests
* Multi-package projects, etc
* Compiler plugins
* How to address the most common diagnostics (eg, hidden packages, version conflicts (less of a problem these days) etc
This task-based documentation would complement the reference material in the manual.
I'm sure that this would not be an arduous task and would significantly reduce the cost of entry to building robust cabal configurations.
Perhaps this already exists somewhere, but I wasn't able to find it in a way that I could grok.
Contributor guide
Assessment
This issue has not been assessed yet.