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

Add report manual #146

Merged
merged 4 commits into from
Apr 11, 2023
Merged

Add report manual #146

merged 4 commits into from
Apr 11, 2023

Conversation

Honny1
Copy link
Member

@Honny1 Honny1 commented Mar 17, 2023

This PR adds a manual about the content of the report.
Link to doc

@Honny1 Honny1 marked this pull request as ready for review March 17, 2023 17:16
@evgenyz
Copy link
Contributor

evgenyz commented Mar 24, 2023

Okay, I have a bit of motion sickness from that manual. Too much movement per square inch of screen. And it is absolutely inaccessible.

@evgenyz
Copy link
Contributor

evgenyz commented Mar 24, 2023

Choose one or two (max!) images where animation is really necessary. Make everything else static (resize the browser windows before screen-shooting them to get better cropping in the docs). Lower the amount of images and describe the instructions in text. User would see the report itself. The important function of the manual is to provide instructions and explain tricky mechanics of the report in plain words.

@Honny1 Honny1 added the documentation Improvements or additions to documentation label Mar 29, 2023
@evgenyz evgenyz merged commit b6d443f into OpenSCAP:main Apr 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants