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

Better and more documentation #586

Open
snorresovold opened this issue Jan 4, 2023 · 6 comments
Open

Better and more documentation #586

snorresovold opened this issue Jan 4, 2023 · 6 comments

Comments

@snorresovold
Copy link
Contributor

snorresovold commented Jan 4, 2023

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.

@MatthijsBurgh
Copy link
Contributor

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.

@snorresovold
Copy link
Contributor Author

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

@MatthijsBurgh
Copy link
Contributor

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.

@snorresovold
Copy link
Contributor Author

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

@snorresovold
Copy link
Contributor Author

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
Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants