Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
Fixing some dead links, but also rephrasing documentation link

Signed-off-by: Erik Jaegervall <erik.jaegervall@se.bosch.com>
  • Loading branch information
erikbosch committed Jul 2, 2024
1 parent b2e3977 commit 7cd6c1f
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Follow the style guide in the [documentation](https://covesa.github.io/vehicle_s

VSS is not concerned with how signals are transmitted and does not consider scaling/offset typically used in transport protocols.
VSS signals typically use the unit used by humans when talking about the value, but prefers SI-units when feasible,
see [documentation](https://covesa.github.io/vehicle_signal_specification/rule_set/data_entry/data_unit_types/) for all supported units.
see [documentation](https://covesa.github.io/vehicle_signal_specification/rule_set/data_entry/data_units/) for all supported units.
If it is unlikely that someone is interested in decimals for this value, select a signed or unsigned integer type.
Select a size which with reasonable margins can cover all vehicles.
If it is likely that decimal values are needed, select float or, if relevant, double.
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

The overall goal of the Vehicle Signal Specification (VSS) is to create a common understanding of vehicle signals in order to reach a “common language” independent of the protocol or serialisation format.

Please find the official documentation at: [Vehicle Signal Specification](https://covesa.github.io/vehicle_signal_specification/).
Generated documentation from latest commit on master branch is available at: [Vehicle Signal Specification Documentation](https://covesa.github.io/vehicle_signal_specification/).

## Getting started

Expand Down
2 changes: 1 addition & 1 deletion docs-gen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Run check with `Check linked documents recursively`
The static page is generated with:

- [HUGO](https://gohugo.io/)
- [Learn Theme](https://themes.gohugo.io/hugo-theme-learn/)
- [Learn Theme](https://github.com/matcornic/hugo-theme-learn)

Please follow the [documentation](https://gohugo.io/documentation/) for installation and further questions around the framework.
Currently, the HUGO version used for generating VSS documentation is `0.103.1`,
Expand Down

0 comments on commit 7cd6c1f

Please sign in to comment.