Are the API docs edited or generated?

Tyler · 2020-03-24T01:57:44.316Z

Is the HTML in github.com/monome/norns/docs generated (with LDoc mentioned in there) or just edited manually? I’ve updated the ParamSet documentation in docs/classes/, but based on the last commit in the same place, it looks like there were also changes to docs/modules/, changing the “Last Update” date.

If it’s generated how can I get setup to contribute to the docs, and if it’s manual do I only need to change “Last Update” of ParamSet in modules?

zebra · 2020-03-24T02:13:09.231Z

you mean?

GitHub

monome/norns

norns is many sound instruments. Contribute to monome/norns development by creating an account on GitHub.

that stuff is generated by LDoc, and is also hosted at https://monome.org/norns.

contribute by forking norns repo, editing the comments in e.g. norns/lua/core/paramset.lua, and submitting a PR.

to regenerate the docs, install ldoc and run it from norns/.

(PS. i edited your post b/c discourse turned a pseudo-url into a broken link. now it’s a working link.)

tehn · 2020-03-24T03:06:09.863Z

apologies, i will regenerate the docs and get them online (this is an easily forgotten step)