sogno-platform / dpsim

Real-time power system simulator including powerflow, (dynamic) phasors and EMT
https://sogno.energy/dpsim/
Mozilla Public License 2.0
67 stars 49 forks source link

Improve documentation UX / DX #156

Open JTS22 opened 1 year ago

JTS22 commented 1 year ago

Some of these issues could be solved by using other tools better suited for building code documentation, e. g. mdbook. This results in a file structure similar to here: https://github.com/rust-lang/nomicon/tree/master/src

m-mirz commented 1 year ago

I am fixing several issues in https://github.com/sogno-platform/dpsim/pull/165

The only issue that I do not know how to address is links between MD files that work in the repo AND the website.

@JTS22 I think that most if not all issues that we have in the documentation are not related to hugo/docsy. We just need to do some clean up work ;-)

m-mirz commented 1 year ago

@dinkelbachjan This feature could be interesting for the discussion about a new solver class structure: https://www.docsy.dev/docs/adding-content/diagrams-and-formulae/#uml-diagrams-with-plantuml