New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: init mkdocs and move documentation from DSP-DOCS into DSP-APP repo (DSP-380) #379
Conversation
docs/README.md
Outdated
The documentation consists of three main topics with subordinate themes: | ||
|
||
1. **index** contains all information about the DSP-APP | ||
1. **how-to-use** contains all about the usage of the DSP-APP modules |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"contains all about" > weird to me
do you mean "all the information about..."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes it's weird... I'll fix it
This section is anyway complete nonsense. I copied from DSP-UI but didn't update the structure 🙈
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
but as you said, "the big refactoring will be part of another PR." So you could aadd this point to the other PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
but as you said, "the big refactoring will be part of another PR." So you could aadd this point to the other PR.
sure... but the content came from DSP-UI documentation and has to be updated for DSP-APP. DSP-APP documentation has another structure than DSP-UI
resolved it in 4440fc4
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the English should be corrected in the next PR
resolves DSP-380
I copied the user-guide from dsp-docs (docs.dasch.swiss) to this repo. I tried to clean up the structure in the main README. The big refactoring will be part of another PR.
The DSP-APP github page is already published: https://dasch-swiss.github.io/dsp-app/