sdatkinson
Publish documentation
Same as https://github.com/sdatkinson/neural-amp-modeler/issues/277, though I'm not sure if Sphinx works for C++ (never tried).
Following up on discussion over in https://github.com/sdatkinson/neural-amp-modeler/issues/277#issuecomment-3144985497
As a project it feels like it would be beneficial to have a single canonical documentation site. I have a lot of experience using Material for MkDocs for docs sites (some links are in the other thread). So my preference would be to use M4MD and theme it to match https://www.neuralampmodeler.com/ and/or https://www.tone3000.com/ etc.
-
I am expecting that we can find ways to extract all the docstrings from each repo (different methods presumably depending on the language) to output markdown, and collect that markdown in a single repo. Scripts and GH Actions can be used to automate those steps.
-
We then build a single docs site which covers all the repos, and because it is a single site which covers everything NAM, it can describe and document user journeys that use more than one of the repos.
-
There is a great project Diátaxis which describes a philosophy for good documentation, which we can use as inspiration. We don't necessarily need to slavishly adhere to it, but there are good ideas in there.
I know nothing about neural networks and machine learning, but hope to learn a lot from being involved in helping with documenting the project. My main job is health tech as a clinician and developer and an open source advocate. I am a guitarist though, with a fair bit of experience using modeling and capture technologies, so I have 'skin in the game' in seeing this amazing open source project achieve industry dominance.
