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 Setup Guides #104

Merged
merged 4 commits into from
May 17, 2021
Merged

Add Setup Guides #104

merged 4 commits into from
May 17, 2021

Conversation

ramadi-a
Copy link
Contributor

Add Setup Guides for Windows and MacOS

  • Add Introduction
  • Add Install SMCE
  • Add Install SmartRover frontend app
  • Add Get Arduino sketch file
  • Add Install MQTT

Resolves #33

ramadi-a and others added 2 commits May 12, 2021 19:33
Add Setup Guides for Windows

- Add Introduction
- Add Install SMCE
- Add Install SmartRover frontend app
- Add Get Arduino sketch file
- Add Install MQTT

Contributes #33

Co-Authored-By: nikalc <69873607+nikalc@users.noreply.github.com>
Add Setup Guides for Windows

- Add Introduction
- Add Install SMCE
- Add Install SmartRover frontend app
- Add Get Arduino sketch file
- Add Install MQTT

Resolves #33

Co-Authored-By: nikalc <69873607+nikalc@users.noreply.github.com>
@ramadi-a ramadi-a added documentation Improvements or additions to documentation sprint-3 User stories & bugs for TBD on sprint 3 JS Javascript work M6 Milestone 6 related issue labels May 12, 2021
Copy link
Contributor

@axe007 axe007 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Color scheme is good.

If this was only for the "Setup guides", then it is fine.

But we need to add subnav for Manual control page, Mission map, mission setup, mission table, user registration and login, settings page. It will be a copy of the wiki page, but within the Frontend app.

But my main concern is if someone is reading this "Help page", then they have already installed the Frontend app. Main purpose of the Help page for the Frontend app, is explain everything only within "Frontend app".

Add how-to to help page

-Add user instructions for how to use manual control page

Next:

-Add user instructions for how to use Mission control page

Contributes #104  and #33
Copy link
Contributor

@axe007 axe007 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes requested:

  1. SmartRover project. Just a welcome text "copying" some project introduction and features part from the Readme and Wiki pages. And just mention how to use Help pages. That's all.
  2. Settings - How to do settings. Especially mention settings where user needs to take a look before starting to use the Frontend app.
  3. Registration and user login. Suggest to the user that it is better to register and login before starting to do anything with the Mission.
  4. Manual control. Just explain everything in one page, so that all parts of the page are relevant to each other.
  5. Mission control.
  6. Troubleshooting. Frequently asked questions & answers if users run into some problems.

And we need to remove top tabs that are currently "Manual control", "Mission control".

Improve help page layout

- Add template for the whole help page
- Add big part of Manual control instructions

Next:

- Add the rest of the instructions.
- Add terminal commands list

Resolves #33  #104
@ramadi-a ramadi-a requested a review from axe007 May 17, 2021 15:42
@ramadi-a
Copy link
Contributor Author

Update help page

  • Add the six mentioned points above
  • Change color scheme

Next:

  • Add the rest of the instructions.
  • Add terminal commands list

Resolves #33 #104

Copy link
Contributor

@axe007 axe007 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Layout is good. And we will work on the content as we update the Wiki pages. Thanks.

@axe007 axe007 merged commit 4fdcff0 into master May 17, 2021
@axe007 axe007 deleted the help-page-branch branch May 17, 2021 22:59
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 JS Javascript work M6 Milestone 6 related issue sprint-3 User stories & bugs for TBD on sprint 3
Projects
SmartRover Scrum Board
Awaiting triage
Development

Successfully merging this pull request may close these issues.

Instructions for users
3 participants