Documentation of the support libraries

[DevTheo]

This is not really an issue (more of an offer), but I wrote a small (and poorly written) python script (awhile ago) that I have used to take each (.p8 and .asm) file in the support library code, read its module/function declarations (and comments) and create a rough set of markdown files. Admittedly the code is terrible and the docs it creates are not pristine, but it works to get a basic listing of what is in the libraries and might be a good start for getting some documentation there.
I would happily pass the script or the rough set of files along if you are interested, let me know how you would want me to pass it along.

[irmen]

does it do more than the symboldumps that are currently being generated?

[DevTheo]

I'm not sure..
I'm now realizing I could just zip up my folder and upload it here.
lib-docs.zip

Here's my script as well (it's not great).
lib-docs.py

(I bet your Python skills are better than mine, but here's what you need to know to run it). It assumes that the folder you are running the script from has a sub-folder named "lib-docs."
I call it like this:
python ./lib-docs.py D:\__compilers\prog8\src\prog8-master\compiler\res\prog8lib\strings.p8
OR
python ./lib-docs.py D:\__compilers\prog8\src\prog8-master\compiler\res\prog8lib\virtual\strings.p8 virtual

The first example puts it into "./lib-docs" and the second drops the markdown file in "./lib-docs/virtual"

(Just trying to give you a hand where I can.. I don't have the time to help out beyond doing something small like this. I find prog8 really interesting.)

[irmen]

I've added docs to a bunch of libraries , not all yet, but there's more now

[irmen]

This will be an ongoing effort so I'm closing the issue. As mentioned a lot of docs have been added already since the issue was raised