search

UbiquityRobotics / learn

Ubiquity Robotics Tutorials Wiki
https://learn.ubiquityrobotics.com
15 stars 13 forks source link

Improving the Conveyorbot docs #74

Open MoffKalast opened 1 year ago

MoffKalast commented 1 year ago

I've ported over the recent changes from breadcrumb_learn and split the merged content onto these pages:

They can all be found under https://github.com/UbiquityRobotics/learn/tree/master/noetic/conveyorbot

Here's a list of things that need to be addressed in the conveyorbot section of the learn docs, based on my observations and old issues in the now deprecated breadcrumb_learn repo in no particular order:

anfederman commented 1 year ago

I could only help if I had a convoyorbot. Is the one still being tested for radio interference available?

On Thu, Feb 16, 2023 at 9:55 AM MoffKalast @.***> wrote:

I've ported over the recent changes from breadcrumb_learn and split the merged content onto these pages:

  • Introduction (basic product description)
  • Basic Usage (for people just using the robot)
  • Fiducial Markers (general info about markers and also how to generate them)
  • Route Setup (how to set up routes from start to finish)
  • Advanced Documentation (anything that requires terminal access to do)

They can all be found under https://github.com/UbiquityRobotics/learn/tree/master/noetic/conveyorbot

Here's a list of things that need to be addressed in the conveyorbot section of the learn docs, based on my observations and old issues in the now deprecated breadcrumb_learn repo in no particular order:

  • An extended explanation about setting up the routes in a clockwise direction
  • Update old aruco images with new stag ones on all pages
  • Fix the route layout demo images so they don't loop in the wrong direction, change arucos to stags on them
  • The basic usage page could probably use more operating info, like keeping robots charged and what to do if the robot is stuck, etc., just things that people using an already set up robot would need to know
  • The touchscreen section of the route setup page needs to be completely rewritten so it features an image for each step of the setup, walls of text need to be broken into shorter paragraphs, likely also needs to be brought up to speed with recent changes, see code of ezmap getting started guide https://learn.ubiquityrobotics.com/noetic_ezmap_gettingstarted for markdown examples of embedding images in text for greater specificity
  • Note the weight limits of the tower shelves somewhere
  • Downloadable marker sets for testing (has its own issue if it ends up being a separate site, but we should note it here as well, since it needs to be linked to or embedded on the learn page)
  • A troubleshooting guide with frequent issues and how to solve them

— Reply to this email directly, view it on GitHub https://github.com/UbiquityRobotics/learn/issues/74, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABHZ377H7JZDSCS3HWZ72ADWXZSXRANCNFSM6AAAAAAU6PPOWQ . You are receiving this because you are subscribed to this thread.Message ID: @.***>

MoffKalast commented 1 year ago

Hey Alan, as of right now I'm not convinced the existing doc is enough to really get to know the full ins and outs of the system yet, so you'd probably have some trouble setting it up.

I think Matjaž should have a good look at it first and bring it up to date with the current state, and then you can go over it and fill in what you think ought to be there from a fresh viewpoint. It would definitely benefit from a native speaker rewording a lot of it regardless.

Shipping you a unit may take some time, so we might as well get on it now. You ought to talk to @NejaE about the logistics.

anfederman commented 1 year ago

Maybe just getting a pi 4 and working on EZmap makes more sense.

On Thu, Feb 16, 2023, 12:45 PM MoffKalast @.***> wrote:

Hey Alan, as of right now I'm not convinced the existing doc is enough to really get to know the full ins and outs of the system yet, so you'd probably have some trouble setting it up.

I think Matjaž should have a good look at it first and bring it up to date with the current state, and then you can go over it and fill in what you think ought to be there from a fresh viewpoint. It would definitely benefit from a native speaker rewording a lot of it regardless.

Shipping you a unit may take some time, so we might as well get on it now. You ought to talk to @NejaE https://github.com/NejaE about the logistics.

— Reply to this email directly, view it on GitHub https://github.com/UbiquityRobotics/learn/issues/74#issuecomment-1433692318, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABHZ37YQ3USR62OTK26XI6DWX2GXJANCNFSM6AAAAAAU6PPOWQ . You are receiving this because you commented.Message ID: @.***>

anfederman commented 1 year ago

I have just gone through the convoyorbot docs and made about a half dozen minor edits. Mostly adding 'the', 'a', a couple of commas and changing a word or two. I think they are in remarkably good shape, though it seems that some damn robot has been editing some of it ;-) I think we can close this.