Skip to content

Commit

Permalink
Write thorough docs for Roads
Browse files Browse the repository at this point in the history
  • Loading branch information
vcschapp committed Jun 23, 2023
1 parent 43279ae commit 729366b
Show file tree
Hide file tree
Showing 37 changed files with 966 additions and 53 deletions.
15 changes: 8 additions & 7 deletions docusaurus/docs/reference/transportation/segment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ import SegmentSchema from '!!raw-loader!@site/docs/_schema/transportation/segmen
import ExampleSimpleRoad from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/simple-road.yaml';
import ExampleLanes from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/lanes-hov.yaml';
import ExampleAccessRestriction from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/access-restriction.yaml';
import ExampleTurnRestrictionSource from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/turn-restriction-source.yaml';
import ExampleTurnRestrictionTarget from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/turn-restriction-target.yaml';
import ExampleTurnRestrictionVia from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/turn-restriction-via.yaml';
import ExampleTurnRestrictionConnector1 from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/turn-restriction-connector1.yaml';
import ExampleTurnRestrictionConnector2 from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/turn-restriction-connector2.yaml';
import ExampleTurnRestrictionSource from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/turn-restriction-02-source.yaml';
import ExampleTurnRestrictionTarget from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/turn-restriction-02-target.yaml';
import ExampleTurnRestrictionVia from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/turn-restriction-02-via.yaml';
import ExampleTurnRestrictionConnector1 from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/turn-restriction-02-connector1.yaml';
import ExampleTurnRestrictionConnector2 from '!!raw-loader!@site/docs/_examples/transportation/docusaurus/turn-restriction-02-connector2.yaml';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Expand Down Expand Up @@ -63,7 +63,8 @@ A segment may have one of three possible sub-types.
</table>

A `road` segment represents a section of any kind of road, street, or
path, including a dedicated path for walking or cycling).
path, including a dedicated path for walking or cycling (but excluding
a railway).

<!--
TODO: Uncomment this paragraph once Roads index page is ready for primetime.
Expand Down Expand Up @@ -130,7 +131,7 @@ The schema for `water` segments is under development.

<div style={{textAlign: 'center'}}>

![Diagram of the "via" transition from source to destination segment.](/examples/turn-restrictions-example.png)
![Diagram of the "via" transition from source to destination segment.](/img/transportation/turn-restriction-02.svg)

</div>

Expand Down
11 changes: 0 additions & 11 deletions docusaurus/docs/themes/transportation/_roads/index.mdx

This file was deleted.

5 changes: 0 additions & 5 deletions docusaurus/docs/themes/transportation/_roads/lanes.mdx

This file was deleted.

21 changes: 19 additions & 2 deletions docusaurus/docs/themes/transportation/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Some common use cases for which data in Overture's Transportation theme schema
may be used include:

- **Mapping.** Rendering a map of connected roads and paths.
- **Routing.** Calculating optimal routes from places to place.
- **Routing.** Calculating optimal routes from place to place.
- **Navigation.** Generating granular instructions on the maneuvers needed to
follow a route.
- **Analytics.** Transportation-related analysis including traffic safety
Expand Down Expand Up @@ -77,11 +77,28 @@ page.

<!--

TODO: A bullet for road, and a page for roads.
TODO: A bullet for travel modes, and a page for travel modes.

-->

<li>

<p>

**Roads.** The Transportation theme schema models any kind of road, street, or
path, including dedicated walking and cycling paths, as `road` segments. Roads
are currently the most developed part of the Transportation schema.

</p>

<p>

Read more about roads on the [Roads](roads) page.

</p>

</li>

</ul>

## Schema Reference
Expand Down
Loading

0 comments on commit 729366b

Please sign in to comment.