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 second review #26

Open
8 of 11 tasks
MaximeTAlgosup opened this issue Jan 23, 2025 · 0 comments
Open
8 of 11 tasks

userManual second review #26

MaximeTAlgosup opened this issue Jan 23, 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 23, 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

  • If other errors are a title you need to put it in PascalCase

Spelling errors

  • None

links misbehavior

  • All links working

tables malfunction

  • No issues

Coherency issues

  • None

Other Suggestion(s)

  • In the How To Use? section, clarify when you are in an explication from when you are in a step
  • In the second terminal, enter the number “1” in the terminal and press enter. -> 2 times in terminal
  • Select the desired output format by pressing “2” and “Enter”, the output format is either in JSON or in XML. -> then, not and
  • Once the output format has been selected, press “1” and “Enter” to calculate the shortest path. The following screen should appear. -> same as above
  • Troubleshooting: Curl: not number list
  • Describe your situation. Please limit your title to a short description of your bug with less than 50 characters. -> The Please... should not be in the step but in a not
@MaximeTAlgosup MaximeTAlgosup added documentation Improvements or additions to documentation medium Medium priority level user manual User manual related labels Jan 23, 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

2 participants