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: update the READMEs and init mkDocs (DSP-1298) #271
Conversation
…wiss/dsp-ui-lib into wip/dsp-1298-update-docs
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.
careful, there is a mix of "DSP-UI-LIB" and "DSP-UI" across different files
see the other comments
the correction of the language typos is probably incomplete
|
||
## Demo Application (Playground) | ||
|
||
### Adding New Component to the Demo Application |
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.
why having all the words in camelcase in all the titles?
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.
@flavens it's how titles are written in English but we should be consistent. The other docs do not have this capitalization. I would suggest using this form of capitalization and changing the titles in the other docs to be the same.
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.
I suggest to do these changes in a separate refactor task (by someone who knows the english language better than me). We have to rewrite and update the "how-to-use"-documentation anyway.
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.
My review may have gotten a little out of hand...let me know if you would like me to help you out with these changes.
This is the big question: The repo's called dsp-ui-lib, but we publish it as dsp-ui. The main README will also be used for the published version (e.g. on npm). What do you suggest @flavens: DSP-UI-LIB or DSP-UI? Btw.: the term EDIT: I updated everything to DSP-UI |
Yes, this should be done (soon) in a separate refactor task. |
I do not mind, as long as we stay consistent! |
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 other things to edit can be done in an other PR as mentioned > approved
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.
You can assign me to a new PR about fixing typos :)
resolves DSP-1298
This PR brings back the dsp-ui documentation from dsp-docs incl. little refactoring (s. description on youtrack). The update of the content and description of each component has to be done in a separate task.
A first version of the documentation is already available on gh page: https://dasch-swiss.github.io/dsp-ui-lib/