diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 88612bb5..18c3d0df 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/README.md b/README.md index 9857bf40..5eea901e 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs-gen/README.md b/docs-gen/README.md index 423aff65..84f6f8e4 100644 --- a/docs-gen/README.md +++ b/docs-gen/README.md @@ -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`,