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

List all available sensors on the README #103

Open
chapulina opened this issue Feb 27, 2021 · 7 comments
Open

List all available sensors on the README #103

chapulina opened this issue Feb 27, 2021 · 7 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@chapulina
Copy link
Contributor

A new user landing at https://ignitionrobotics.org/libs/sensors should have a quick way to find out what sensors are supported.

Desired behavior

List all sensors on the README, with links to their APIs, like Altimeter.

Alternatives considered

The list could be somewhere else, but the README is probably the most evident place, both to users navigating to https://ignitionrobotics.org/libs/sensors and to https://github.com/ignitionrobotics/ign-sensors/.

Implementation suggestion

Use a markdown table or an unordered list.

@chapulina chapulina added enhancement New feature or request good first issue Good for newcomers labels Feb 27, 2021
@benediktkreis
Copy link

This would be indeed very helpful! Furthermore, I suggest that the README list includes one SDF implementation example and a list of all available tags with a hint if they are required or optional.

@tejalbarnwal
Copy link
Contributor

Hey, could you please assign this to me?

@iche033
Copy link
Contributor

iche033 commented Oct 10, 2022

Hey, could you please assign this to me?

done, assigned.

@tejalbarnwal
Copy link
Contributor

Hey, I was wondering whether I should mention the links for the API for each version of Gazebo Ignition Release?
and creating a format as below

  • Sensor Name
    • API Link: Citadel | Fortress | Garden
    • Available Tags
    • Implementation Example
    • Any other note related to implementation

I apologise for asking such a silly question, but I am just getting started with open source contributions and would like to confirm it so that I do not make a mistake.

@mjcarroll
Copy link
Contributor

@tejalbarnwal I think that is a great format. By available tags, do you mean pointing off to the corresponding sdformat documentation? eg http://sdformat.org/spec?ver=1.9&elem=sensor#sensor_altimeter for altimeter?

@tejalbarnwal
Copy link
Contributor

I was actually planning to list all the tags individually.
However now I think yeah, this is a better idea to point to the respective sdformat documentation.

@aagrawal05
Copy link

Hi, is this issue still active? If so what is remaining to be done?
The landing page appears to still not have the updated description.
I'd be happy to help.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

6 participants