I'm trying to enhance the documentation.
English is not my mother tongue, so it may need some minors corretions, I'm trying to do my best.
Next, I plan to add a more detailed configuring part in this readme (using the Overall Structure of the website).
In my opinion, just giving some configuration examples is a little short.
Personally, I would prefer to have an offline documentation [0]. I think that way, having code and docs side-by-side will greatly reduce the amount of world needed to properly document the thing.
So it will means that it will be some kind of man pages, or some literate haskell files. Like that if documentation isn't up-to-date, it will not compile.
[0] Not a big advantage. But, for example, I love to tinker my openbsd box when network is down, it's a really awesome experience. Focus is so bigger and stronger without networking.
ethercrow
commented
7 years ago
I'm trying to enhance the documentation. English is not my mother tongue, so it may need some minors corretions, I'm trying to do my best.
Next, I plan to add a more detailed
configuringpart in this readme (using the Overall Structure of the website). In my opinion, just giving some configuration examples is a little short.Personally, I would prefer to have an offline documentation [0]. I think that way, having code and docs side-by-side will greatly reduce the amount of world needed to properly document the thing. So it will means that it will be some kind of man pages, or some literate haskell files. Like that if documentation isn't up-to-date, it will not compile.
[0] Not a big advantage. But, for example, I love to tinker my openbsd box when network is down, it's a really awesome experience. Focus is so bigger and stronger without networking.