search

UbiquityRobotics / learn

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

Conveyrobot docs update #76

Open MatjazBostic opened 1 year ago

MatjazBostic commented 1 year ago

I have updated the Conveyorbot docs to the point that I think they are ready to be sent to potential users. I think it is of high importance to send this manual to potential buyers of Conveyorbot, because it includes many details of how the robot works. @davecrawley I think also you should read through the docs carefully, so that you will have a better idea of the robot and will be able to better present it to potential buyers.

anfederman commented 1 year ago

I am away from home until Sunday. I will review next week.

On Fri, Apr 14, 2023, 10:20 AM mbostic @.***> wrote:

I have updated the Conveyorbot docs to the point that I think they are ready to be sent to potential users. I think it is of high importance to send this manual to potential buyers of Conveyorbot, because it includes many details of how the robot works. @davecrawley https://github.com/davecrawley I think also you should read through the docs carefully, so that you will have a better idea of the robot and will be able to better present it to potential buyers.

You can view, comment on, or merge this pull request online at:

https://github.com/UbiquityRobotics/learn/pull/76 Commit Summary

File Changes

(3 files https://github.com/UbiquityRobotics/learn/pull/76/files)

Patch Links:

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

MoffKalast commented 1 year ago

Alright, so while we're at it I've fed the files into GPT 4 to make them easier to read. I've checked it all and I think the information is all the same as before, just worded a bit differently and sometimes a lot more concisely, especially those walls of text. @mbostic can you give them a quick re-check anyway just to be sure?

We should probably feed the entirely of learn into it for grammar checks once someone has the time haha.

Or as it would say (for comparison):

I've processed the files using GPT-4 to enhance their readability. I've verified the content, and it seems the information remains consistent with the original, just expressed more succinctly and with improved clarity, particularly in the lengthy sections. @mbostic, would you mind giving them a swift review to confirm?

It might be a good idea to run the entire learn database through GPT-4 for grammar improvements when someone has the bandwidth to do so, haha.

MatjazBostic commented 1 year ago

@MoffKalast I noticed that it used a bit weird wording in some places. For example "Turn marker creates crossroads". "Turn marker can be used to create crossroads" would be much better here IMO. I also think it removed some quite important parts of text in some places as I looked through the changes quickly. It looks like I'll need some time to go through everything, I'll do it next week after I finish with person follower.

It seems like a good idea to do this kind of processing with GPT-4, since it really improves wording of sentences and fixes grammar problems, but I think the results should be checked carefully.

MoffKalast commented 1 year ago

Yeah agreed that it could use some additional explanations here and there. There's a lot of places where shortening the description makes the data less explicit and easier to miss. I did highlight a thing or two in bold, but we likely need more of that.

For example "Turn marker creates crossroads". "Turn marker can be used to create crossroads" would be much better here IMO.

I guess that depends on what's the exact intention there. In the sense where you're laying down the route "creates" makes more straightforward sense, but it doesn't imply that you have to input the marker into the route itself on the touchscreen, so "can be used" might be more accurate. I doubt anyone would pick up on that detail while reading it for the first time though, so it should be specified far more clearly than both of these options. Maybe we can let @anfederman read through it first to see where he gets most confused and work on that.

MatjazBostic commented 1 year ago

@MoffKalast @davecrawley @anfederman

I read through the GPT4's fixes and they seemed mostly ok and I just did two minor fixes. So the docs are ready to be reviewed.