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

Different sample applications for manual and quick guide (#1171) #1173

Merged
merged 1 commit into from
Sep 12, 2020
Merged

Different sample applications for manual and quick guide (#1171) #1173

merged 1 commit into from
Sep 12, 2020

Conversation

deining
Copy link
Contributor

@deining deining commented Sep 12, 2020

No description provided.

@codecov-commenter
Copy link

codecov-commenter commented Sep 12, 2020

Codecov Report

Merging #1173 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master    #1173   +/-   ##
=========================================
  Coverage     94.29%   94.29%           
  Complexity      455      455           
=========================================
  Files             2        2           
  Lines          6661     6661           
  Branches       1792     1792           
=========================================
  Hits           6281     6281           
  Misses          102      102           
  Partials        278      278           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 79d01ff...e42f9d7. Read the comment docs.

@remkop remkop added this to the 4.6 milestone Sep 12, 2020
@remkop remkop merged commit 0843a62 into remkop:master Sep 12, 2020
@remkop
Copy link
Owner

remkop commented Sep 13, 2020

Merged.
Very nice, thank you!
I’m still polishing it a bit and will update later.

@remkop
Copy link
Owner

remkop commented Sep 13, 2020

Thanks again for the improvements.
I made some more changes and published the user manual and Quick Guide now.
Let me know what you think.

@deining
Copy link
Contributor Author

deining commented Sep 13, 2020

Thanks again for the improvements.

You are welcome.

I made some more changes and published the user manual and Quick Guide now.

I'm glad you made some polishment here. Your corrections on the quickguide are real improvements, I really appreciate your input here.

Let me know what you think.

Having worked on the documentation a bit, I'm on the impression that the current single page approach is reaching its limits.
Have you every thought about a multi page approach for the documentation?

@remkop
Copy link
Owner

remkop commented Sep 13, 2020

I like the single page: Having everything on a single page means that users can use browser search (Ctl-F) to easily find whatever they’re looking for. Multiple pages makes this harder for users while giving no advantage that I can see...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants