docs: improve documentation (DSP-1693) #62
Conversation
irinaschubert
changed the title
irinaschubert
changed the title
irinaschubert
changed the title
irinaschubert
changed the title
There was a problem hiding this comment.
good job, that improves the documentations a lot!
I added some comments and suggestions, but that's all cosmetics, feel free to merge it as is, if you prefer.
Another thought that came to my mind: Some of the documentation pages are extremely long. It might be worth considering to split those into multiple files to have them as sub-pages of the page in the TOC
Co-authored-by: Balduin Landolt <33053745+BalduinLandolt@users.noreply.github.com>
…om/dasch-swiss/dsp-tools into wip/DSP-1693-improve-documentation
|
@BalduinLandolt , thank you for the feedback, I considered almost everything. I also split the index page into several sub pages ("Overview", "Usage" and "Information for developers"). I totally agree that it would be preferable to also split the two other long pages but I think they should undergo an intense revision anyway, so this could be done at that point. |
resolves DSP-1693