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: improve documentation (DSP-1693) #62

Merged
merged 10 commits into from Jun 7, 2021

Conversation

@irinaschubert
Copy link
Collaborator

@irinaschubert irinaschubert commented Jun 1, 2021

resolves DSP-1693

@irinaschubert irinaschubert changed the title Wip/dsp 1693 improve documentation docs: improve documentation Jun 1, 2021
@irinaschubert irinaschubert changed the title docs: improve documentation docs: improve documentation (DSP-1693) Jun 1, 2021
@irinaschubert irinaschubert changed the title docs: improve documentation (DSP-1693) doc: improve documentation (DSP-1693) Jun 1, 2021
@irinaschubert irinaschubert changed the title doc: improve documentation (DSP-1693) docs: improve documentation (DSP-1693) Jun 1, 2021
@irinaschubert irinaschubert marked this pull request as ready for review Jun 2, 2021
Copy link
Collaborator

@BalduinLandolt BalduinLandolt left a 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

Loading

docs/dsp-tools-create.md Show resolved Hide resolved
Loading
docs/dsp-tools-create.md Show resolved Hide resolved
Loading
docs/dsp-tools-create.md Outdated Show resolved Hide resolved
Loading
docs/dsp-tools-create.md Outdated Show resolved Hide resolved
Loading
docs/dsp-tools-create.md Outdated Show resolved Hide resolved
Loading
docs/dsp-tools-create.md Show resolved Hide resolved
Loading
docs/index.md Outdated Show resolved Hide resolved
Loading
docs/index.md Outdated Show resolved Hide resolved
Loading
docs/index.md Outdated Show resolved Hide resolved
Loading
docs/index.md Outdated Show resolved Hide resolved
Loading
@irinaschubert
Copy link
Collaborator Author

@irinaschubert irinaschubert commented Jun 7, 2021

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

Loading

@irinaschubert irinaschubert merged commit 591b5ad into main Jun 7, 2021
2 checks passed
Loading
@irinaschubert irinaschubert deleted the wip/DSP-1693-improve-documentation branch Jun 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants