search

srieger1 / digsinet

multiple twins (siblings) of a network topology (e.g., based on containerlab) with continuous data exchange
https://srieger1.github.io/digsinet/
5 stars 0 forks source link

Documentation #18

Closed Lachstec closed 1 month ago

Lachstec commented 2 months ago

Some form of Documentation would be useful to help onboarding new contributors. Maybe Pdoc deployed to Github Pages?

srieger1 commented 1 month ago

Thanks to @Lachstec initial version of the documentation is now avaiable as github page and now also referenced as about at the top of the repo

Lachstec commented 1 month ago

The docs have been updated including information about the configuration and current limitations. I think this issue can be closed for now, as some major changes are planned, thus more documentation would be a bit wasted.

srieger1 commented 1 month ago

@Lachstec absolutely! Thanks again for your work! I wanted to take a look into generating the static pages of the documentation directly in the GitHub action, but this can also be done later. I'll close the issue.