essence-of-live-coding
essence-of-live-coding copied to clipboard
Improve the docs of the main module
Ideally, https://hackage.haskell.org/package/essence-of-live-coding-0.2.5/docs/LiveCoding.html gives a good entry point to the library. Right now it just vomits all imports concatenated.
- There should be sections corresponding to the modules (maybe these sections can be added in the modules themselves)
- There should be an intro and some examples
- Unimportant things like
Data
should be hidden or come last
hey! Can I Handle This Issue!?and fix it
Sure :) go for it! All you need to know is how haddock and module import/export work. I'll help you through the PR process.
Hey! I Am Beginner and Learning Things on Github! Can I Know How Can I connect to You?!(any social media links or mail)
All communication regarding this repo is over Github, that's all you'll need.
I don't have any idea about haddock module import-export! from where can I know this
Probably it is best if you gather some Haskell experience first by writing a small program or library, then read the Haddock documentation: https://haskell-haddock.readthedocs.io/en/latest/index.html