roslibjs icon indicating copy to clipboard operation
roslibjs copied to clipboard

Better and more documentation

Open snorresovold opened this issue 3 years ago • 6 comments

The documentation for Roslibjs is very poor and there is far from enough.

the example folder has a few examples that work when you understand them, but there isn't enough and it's all written in plain html.

We need more examples for doing more stuff so people have the ability to learn by example and see how other people may have solved problems they have.

we also need documentation in other versions than plain html, I for example use React and Typescript, I had a very hard time making Roslibjs work in this environment even though it's an npm package with at the time of writing this almost 3 thousand weekly downloads.

snorresovold avatar Jan 04 '23 09:01 snorresovold

Sorry, but I don't have the time do this. I am happy to assist people. It would be nice if questions of people would lead to more docs and examples. But this is an open-source project. So it requires a community to keep it up.

Unless you are going to pay me money to work on this full-time.... But you are probably not going to do that.

But if I understand correctly, you now have a React example. please share it with us. It gives you credit, so people will help you in the future too.

MatthijsBurgh avatar Jan 04 '23 09:01 MatthijsBurgh

Yes i was thinking of maybe adding it sometime after lunch, how is the process of cotributing to the project?

snorresovold avatar Jan 04 '23 09:01 snorresovold

Just fork the repo, commit your changes to your fork and open a PR. Please don't commit your build files, CI will update them.

MatthijsBurgh avatar Jan 04 '23 10:01 MatthijsBurgh

Made a simple example just to test if everything is correct. Does this look good to you @MatthijsBurgh ? #587

snorresovold avatar Jan 04 '23 11:01 snorresovold

If this looks correct then I'll add a few more examples today, but I don't know how many, I'll probably then continue to add some as i find them

snorresovold avatar Jan 04 '23 11:01 snorresovold

Just found this project as well. https://github.com/pantor/ros-control-center This can be used as e good example for using angular.

snorresovold avatar Jan 04 '23 14:01 snorresovold