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

Fix corrupted links, wrong branch references and incorrect commands w… #28

Merged

Conversation

dennismeister93
Copy link
Contributor

This PR fixes corrupted links, wrong branch references and incorrect commands within getting started

## Intro

The [COVESA Vehicle Signal Specification](https://covesa.github.io/vehicle_signal_specification/) (VSS) defines the names and semantics of a large set of *data entries* that represent the current and/or intended state of a vehicle's sensors and actuators organized in a tree-like structure. For example, the vehicle's current speed is represented by the `Vehicle.Speed` entry.
The [COVESA Vehicle Signal Specification](https://covesa.github.io/vehicle_signal_specification/) (VSS) defines the names and semantics of a large set of _data entries_ that represent the current and/or intended state of a vehicle's sensors and actuators organized in a tree-like structure. For example, the vehicle's current speed is represented by the `Vehicle.Speed` entry.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any particular reason why you prefer _something_ (something) for italics rather than *something* (something). They both result in the same result and are listed at https://daringfireball.net/projects/markdown/syntax , but maybe there is a style guide somewhere that prefers one over the other?

Copy link
Contributor Author

@dennismeister93 dennismeister93 May 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The formatting comes from my default formatter prettier https://prettier.io/ which follows:
https://spec.commonmark.org/0.31.2/

as you stated, both are valid and both are resolving to <p><em>foo bar</em></p>.
I can change it back to the initial spelling, no problem :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nah, I was just curious.

And does https://spec.commonmark.org/0.31.2/ actually state that underscore is preferred over asterisk? I found a lot of examples of both in section 6.2, but no clear statements that one is preferred over the other I think.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I actually also didnt find if there are any preferations :D

* Subscription: Subscribing VSS datapoints
* Subscribing sensor values
* Subscribing current or target value for actuators
- Read: Reading VSS datapoints
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any style guide that recommends -? Both are valid and gives the same result, right? (ref: https://daringfireball.net/projects/markdown/syntax#list)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same as above :)

* Arrays are not supported in conditions as part of queries (i.e. in the WHERE clause).
* Arrays are not supported by the CLI (except for displaying them)
- Arrays are not supported in conditions as part of queries (i.e. in the WHERE clause).
- Arrays are not supported by the CLI (except for displaying them)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this information maybe outdated?, related to #15
FYI @lukasmittag @Chrylo

Copy link
Contributor

@erikbosch erikbosch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. We can certainly improve things further but good enough for now as I see it.

@erikbosch erikbosch force-pushed the update-readme-userguide branch from 477041f to 44c2c07 Compare May 8, 2024 06:39
@erikbosch
Copy link
Contributor

Did a rebase from UI

@erikbosch erikbosch merged commit 4848d0b into eclipse-kuksa:main May 8, 2024
21 checks passed
@erikbosch erikbosch deleted the update-readme-userguide branch May 8, 2024 09:03
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

Successfully merging this pull request may close these issues.

3 participants