Open Marcono1234 opened 3 years ago
Probably best to move relevant stuff to readme. Writing javadoc is a pain for formatting large pieces of content like "overviews".
I wrote a whole bunch of docs when I first developed it. There is also an extended blog post here that should probably be adapted to documentation within the project.
It appears
overview.html
is not referenced anywhere and is quite outdated, e.g. it still lists the following requirement:It looks like commit 28f4679 accidentially removed it from the source folder, therefore it is not part of the javadoc anymore.
Would it make sense to move relevant information from it to the README and then remove
overview.html
, or to update it and add it to resources folder so it is part of the javadoc?