search

w3c / vsso

The Vehicle Signal Ontology (VSSo) based on COVESA VSS and making use of the SOSA/SSN modeling patterns
Other
15 stars 12 forks source link

Documentation issues in ReSpec #23

Closed danielwilms closed 2 years ago

danielwilms commented 2 years ago

Found issues in respec:

Broken Links

in the vsso (signal expanded) document there are numerous class definitions such as:

<section id="ABSIsActive">
    <h4>ABSIsActive</h4>
    <table class="def">
        <tr><th>Owl Class:</th><td><a href="[https://github.com/w3c/vsso#ABSIsActive"><code>vsso:ABSIsActive</code></a></td></tr>](https://github.com/w3c/vsso#ABSIsActive%22%3E%3Ccode%3Evsso:ABSIsActive%3C/code%3E%3C/a%3E%3C/td%3E%3C/tr%3E)
        <tr><th class="prop">Definition:</th><td><p>Indicates if ABS is enabled. True = Enabled. False = Disabled.</p></td></tr>
        <tr><th class="prop">Sub-class of:</th><td><a href="#ActuatableVehicleProperty">ActuatableVehicleProperty</td></tr>

    </table>
</section>

ABSIsActive should be a local reference instead of absolute and as #ActuatableVehicleProperty is in core, should be absolute or relative because it is a broken link. There is also a missing tag before , this looks to be repeated for all the class definitions.

Snapshots

There is no need for saving a static snapshot of rendered respec document, in fact it could lead to confusion as it might not get updated consistently although perhaps you handled that in your tooling.