search

status-im / nim-chronos

Chronos - An efficient library for asynchronous programming
https://status-im.github.io/nim-chronos/
Apache License 2.0
362 stars 51 forks source link

Documentation #311

Closed Menduist closed 1 year ago

Menduist commented 2 years ago

Generate documentation on each push to master: https://status-im.github.io/nim-chronos/docs/chronos.html

And some touch ups on existing documentation

cheatfate commented 2 years ago

Why we should keep references to other projects if this projects do not keep references to chronos? So as an example:

  1. nim-metrics do not have first class reference like chronos have, so we should not make it first class too, and put it in the list of projects which are using chronos
  2. 2Defi do not have any references on chronos - so there no need to advertise this project too.
  3. libp2p do not have any references on chronos.
Menduist commented 2 years ago

Why we should keep references to other projects if this projects do not keep references to chronos?

libp2p mentions chronos as part of the first tutorial on how to use libp2p, it's one of the installed dependency, and is imported in almost every file of libp2p We can add it to the libp2p readme if you want

arnetheduck commented 2 years ago

Why we should keep references to other projects

these references provide examples for how to use chronos - since the project itself lacks docs / examples / tutorials, looking at other code provides a substitute ("how do I download a file with http?")

cheatfate commented 2 years ago

Why we should keep references to other projects

these references provide examples for how to use chronos - since the project itself lacks docs / examples / tutorials, looking at other code provides a substitute ("how do I download a file with http?")

Looks like we do not have any examples on how to download file via http in provided links. Also because this PR named as documentation we could move this links away from main README deeper inside documentation Examples section. Like projects do.

Menduist commented 2 years ago

@arnetheduck @cheatfate other remarks on this PR? I would like to have at least the website up, and then we can work on better documentation content