iohk-monitoring-framework icon indicating copy to clipboard operation
iohk-monitoring-framework copied to clipboard

Published 20 hours ago • verified publisher icon input-output-hk

Improve documentation

Open hasufell opened this issue 5 years ago • 0 comments

Due to https://github.com/input-output-hk/cardano-wallet/pull/2322 I wanted to interface more deeply with iohk-monitoring.

The problems I had:

  1. No haddock documentation. The PDF wasn't really a sufficient substitute for navigating the API.
  2. The PDF was quite inaccessible to me. The code examples are hard to read, copy and parts of it exceed the PDF length, rendering various lines unreadable. It's quite hard to have an overview of what to do and where to start. I believe that extensive haddock documentation in the spirit of optics is the way to go.
  3. certain things are underdocumented like options. I could find some of it here https://github.com/input-output-hk/cardano-node/blob/master/doc/getting-started/understanding-config-files.md#fine-grained-logging-control but I don't know why this is documented at the node.

hasufell avatar Nov 17 '20 14:11 hasufell