Skip to content
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

Merged
merged 8 commits into from Feb 12, 2021

Conversation

kilchenmann
Copy link
Contributor

@kilchenmann kilchenmann commented Feb 10, 2021

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/

@kilchenmann kilchenmann self-assigned this Feb 10, 2021
@kilchenmann kilchenmann added the documentation Add or update doc files label Feb 10, 2021
@kilchenmann kilchenmann requested a review from flavens Feb 10, 2021
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
Copy link
Contributor

@flavens flavens Feb 11, 2021

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..."

Copy link
Contributor Author

@kilchenmann kilchenmann Feb 12, 2021

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 🙈

Copy link
Contributor

@flavens flavens Feb 12, 2021

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.

Copy link
Contributor Author

@kilchenmann kilchenmann Feb 12, 2021

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

@kilchenmann kilchenmann requested a review from flavens Feb 12, 2021
Copy link
Contributor

@flavens flavens left a comment

the English should be corrected in the next PR

@kilchenmann kilchenmann merged commit 07f5067 into main Feb 12, 2021
@kilchenmann kilchenmann deleted the wip/dsp-380-init-docs branch Feb 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Add or update doc files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants