Repo Wiki Page

[AOS55]

Repo Wiki Page

Would we like to make the docs a little easier to read for new users and provide some further explanations of how to use the new features. I found it a little tricky to follow the large markdown files in the docs folder working alongside the book(s).

Wiki:

• I had a go at building a site by moving docs over to MKDocs. Take a look at the user_guide/Config page for a completed example.
• The site can be rendered localy following the instructions in the readme.md.
• It might be nice to add some tutorials to the docs too?

Undocumented Features:

Not sure if we should add these into the documentation to explain how each of the system modules works, as already described in blog posts, but could be helpful to have a more direct doc and maybe tutorial?

• attenuate vol, based on blog
• dynamic_optimise, based on blog
• rules, don't want to step on the book here though as assume all in there?
• risk again from this blog