Skip to content

Commit

Permalink
Deployed 17007b8 to pr-170 with MkDocs 1.4.3 and mike 2.2.0.dev0
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Dec 9, 2024
1 parent 21cc866 commit 53d87bc
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3152,7 +3152,7 @@ <h2 id="design-concept">Design Concept<a class="headerlink" href="#design-concep
<code>autoware_lanelet2_map_validator</code> achieves this by running a list of small validators.
In other words, each vector map requirement will be validated by one or more validators.
It is recommended to keep validators small and they don't have to be unique to a specific requirement so that we can broaden the expression of map requirements. (It doesn't mean that a validator should output only one kind of error!)</p>
<p>The list of small validators will be defined as a JSON file (see <a href="https://github.com/autowarefoundation/autoware_tools/blob/main/map/autoware_lanelet2_map_validator/autoware_requirement_set.json"><code>autoware_requirement_set.json</code></a> for an example), and the output will also be a JSON file that appends validation results to a copy of the input. See <a href="https://github.com/autowarefoundation/autoware_tools/tree/main/map/autoware_lanelet2_map_validator#relationship-between-requirements-and-validators">How to use <code>autoware_lanelet2_map_validator</code></a> for further information about how the input and output are processed.</p>
<p>The list of small validators will be defined as a JSON file (see <a href="https://github.com/autowarefoundation/autoware_tools/blob/main/map/autoware_lanelet2_map_validator/autoware_requirement_set.json"><code>autoware_requirement_set.json</code></a> for an example), and the output will also be a JSON file that appends validation results to a copy of the input. See <a href="https://github.com/autowarefoundation/autoware_tools/tree/main/map/autoware_lanelet2_map_validator#how-to-use">How to use <code>autoware_lanelet2_map_validator</code></a> for further information about how the input and output are processed.</p>
<p><img alt="autoware_lanelet2_map_validator_input_and_output" src="../../media/autoware_lanelet2_map_validator_io.svg"></p>
<p>Please note that the validators are categorized according to <a href="https://autowarefoundation.github.io/autoware-documentation/main/design/autoware-architecture/map/map-requirements/vector-map-requirements-overview/">the vector map requirements written in the Autoware Documentation</a>. If there are any suggestions for new categories please let the pull request (PR) reviewers know. The available categories as of now are</p>
<ul>
Expand Down Expand Up @@ -3257,7 +3257,7 @@ <h3 id="4-write-a-document">4. Write a document<a class="headerlink" href="#4-wr
</ul>
</li>
</ul>
<p>In addition, add a link of the document to the table <a href="../#relationship-between-requirements-and-validators">Relationship between requirements and validators</a> in the main <code>README.md</code> to let the users know which map requirement your validator relates with.</p>
<p>In addition, add a link of the document to the table <a href="https://github.com/autowarefoundation/autoware_tools/tree/main/map/autoware_lanelet2_map_validator#relationship-between-requirements-and-validators">Relationship between requirements and validators</a> in the main <code>README.md</code> to let the users know which map requirement your validator relates with.</p>
<h3 id="5-submit-a-pull-request">5. Submit a pull request<a class="headerlink" href="#5-submit-a-pull-request" title="Permanent link">#</a></h3>
<p>Submit a pull request to the <a href="https://github.com/autowarefoundation/autoware_tools">autowarefoundation/autoware_tools</a> repository.</p></div>

Expand Down
Binary file modified pr-170/sitemap.xml.gz
Binary file not shown.

0 comments on commit 53d87bc

Please sign in to comment.