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

Update documentation #752

Merged
merged 1 commit into from
Jul 9, 2024
Merged

Update documentation #752

merged 1 commit into from
Jul 9, 2024

Conversation

erikbosch
Copy link
Collaborator

Fixing some dead links, but also rephrasing documentation link

@@ -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/).
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

So this is the part worth discussing. I have now and then thought that term "official documentation" maybe is a bit misleading, as the source is in this repo and what you get on the site is just something generated from latest master-branch of this repo. So maybe this is a better phrasing, but I am open to other opinions/suggestions

Fixing some dead links, but also rephrasing documentation link

Signed-off-by: Erik Jaegervall <erik.jaegervall@se.bosch.com>
@erikbosch
Copy link
Collaborator Author

MoM:

  • Please review
  • Daniel: Generated documentation contains most info but not all

@adobekan
Copy link
Collaborator

adobekan commented Jul 9, 2024

Decision to merge.

@adobekan adobekan merged commit 5b67759 into COVESA:master Jul 9, 2024
4 checks passed
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.

2 participants