mratsim / weave

A state-of-the-art multithreading runtime: message-passing based, fast, scalable, ultra-low overhead
Other
541 stars 21 forks source link

Docs - initial commit #142

Closed mratsim closed 4 years ago

mratsim commented 4 years ago

This layout a documentation system and the corresponding command

to ease update.

This targets writing guides, tutorials and how-to, i.e. from https://documentation.divio.com/ image

  • tutorials and how-to guides are both concerned with describing practical steps
  • how-to guides and technical reference are both what we need when we are at work, coding
  • reference guides and explanation are both concerned with theoretical knowledge
  • tutorials and explanation are both most useful when we are studying, rather than actually working

image

Regarding API doc

Ideally:

would help generate html or json that can be post-processed and included into the book.