Skip to content

Improve documentation

Created by: paigeweber13

Similar to issue #273 (closed). Issue #201 is also relevant.

I feel like the documentation could be improved, and I would like to help. Some things I would have liked to have in the documentation as I started learning to use LIKWID:

  • An up front explanation of the differences between the marker API and perfmon API and their use-cases.
  • Information about how to avoid using the CLI if one wishes to extend likwid or use it in a larger project.
  • Working example code for the internal marker api. The file at examples/C-internalMarkerAPI.c does not work with the current version of likwid.

Are these good things to start with? Or are there other priorities for the documentation?

I noticed the documentation is spread across the wiki, doxygen comments, man pages, and the readme file. If I were to begin improving the documentation, what medium should I use? If doxygen comments, the readme, or man pages are preferred, I can make a pull request. But if the wiki is preferred, how can I ensure changes are approved?

I'd also be happy to work on creating a static site (as mentioned in #273 (closed)) that could be maintained with pull requests and hosted on github pages, if the likwid team would like to take the documentation in that direction. This could be easily done with the man pages.