I'm pleased to announce a new documentation site for midas.
https://midas.triumf.ca/docs replaces the old MidasWiki. We'll keep the
MidasWiki around for a while, but the content has been replaced with links to
the relevant place in the new docs.
Most people will be interested in the "Feature guide", but there are also intro
pages for new users, reference pages for power-users, and auto-generated API
documentation based on the source code.
The pages for each feature are generally split into an overview (useful for
everyone), a configuration page (explaining ODB keys etc), and a programming
page (which shows examples in C++, Python and JavaScript).
The new system has some very nice usability improvements compared to MidasWiki.
One thing I particularly like is if you hover over a link, you get a preview of
the target page. Very useful for quickly checking the reference without losing
the context of your current page.
The search system has some useful filters based on the audience of each page. If
you know you want to see programming examples, for example, click the
"Developer" filter.
The new documentation is stored in the midas repository itself, in $MIDASSYS/
docs/mkdocs. This means you can:
* build the docs yourself if you wish (see https://midas.triumf.ca/docs/develop/
reference/internals/documentation/)
* point your friendly AI assistant towards the markdown files to kickstart its
knowledge
Let me know if you have any issues with the new documentation
(bsmith@triumf.ca). There is a lot of new content, and a lot has been
restructured compared to the MidasWiki. I hope it will prove useful once you get
used to the new structure.
Cheers,
Ben |