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

userManual.md review #13

Open
10 of 13 tasks
MaximeTAlgosup opened this issue Jan 20, 2025 · 0 comments
Open
10 of 13 tasks

userManual.md review #13

MaximeTAlgosup opened this issue Jan 20, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation medium Medium priority level user manual User manual related

Comments

@MaximeTAlgosup
Copy link
Collaborator

MaximeTAlgosup commented Jan 20, 2025

Background Information

Errors and Improvements would be displayed this way:

Line number: error spotted -> potential solution

convention:

  • what is already written
  • what's wrong
  • potential solution

Improvement(s)

Naming convention

Name:

  • user manual -> user manual userManual

Table of content:

  • Installation guide -> Installation guide Guide
  • How to use? -> How to use To Use?

In document:

  • Installation guide -> Installation guide Guide
  • How to use? -> How to use To Use?

Spelling errors

How To Use?:

  • 1. Double click on the file PathQuick. -> Double click Double-click on the file PathQuick.

links misbehavior

  • No links

tables malfunction

Installation Guide:

  • Bolden the name of the sections for a better readability.

Coherency issues

How To Use?:

  • In order to -> To

Other Suggestion(s)

  • second step of installation guide: Click on releases THEN ... not and.
  • Add some more parts?
  • Add a link to the user manual within the repository, or a pdf.
  • Add some more pictures to illustrate your sayings
@MaximeTAlgosup MaximeTAlgosup added documentation Improvements or additions to documentation medium Medium priority level user manual User manual related labels Jan 20, 2025
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 medium Medium priority level user manual User manual related
Projects
None yet
Development

No branches or pull requests

3 participants