Updating staging from dev for documentation (#251)

* update language around subtypes for the divisions theme documentation (#248) * update language around subtypes for the divisions theme * add dependency to the list of available subtypes * [documentation] Address scaffolding for schema pages (#233) * address scaffolding for schema pages * Initial schema docs description * Update address.mdx --------- Co-authored-by: Jacob Wasserman <[email protected]> --------- Co-authored-by: Dana Bauer <[email protected]> Co-authored-by: Jacob Wasserman <[email protected]>
OvertureMaps · Jul 17, 2024 · 88ffb3e · 88ffb3e
1 parent d4fd084
commit 88ffb3e
Show file tree

Hide file tree

Showing 5 changed files with 204 additions and 5 deletions.
diff --git a/docusaurus/docs/schema/concepts/by-theme/addresses/index.mdx b/docusaurus/docs/schema/concepts/by-theme/addresses/index.mdx
@@ -0,0 +1,23 @@
+---
+title: Addresses
+draft: true
+---
+
+## Overview
+The Overture Address theme is a compilation of open address datasets usually
+published by local authorized sources. In our initial release, we use the datasets
+that are collected and distributed by [OpenAdddresses](https://openaddresses.io).
+
+The initial schema for addresses is fairly simple and is expected to expand into
+more complex addressing schemes.
+
+
+
+## Feature types
+The address theme has a single feature type.
+- `address` is a point feature type representing a single address point.
+
+## Theme concepts
+
+## Schema reference
+- [Explore the schema for the address feature type](/schema/reference/Addresses/address)
diff --git a/docusaurus/docs/schema/reference/addresses/address.mdx b/docusaurus/docs/schema/reference/addresses/address.mdx
@@ -0,0 +1,69 @@
+---
+title: address
+---
+
+import CodeBlock from '@theme/CodeBlock';
+import JSONSchemaViewer from "@theme/JSONSchemaViewer";
+import generateResolverOptions from "@site/src/components/shared-libs/generateResolverOptions"
+import yamlLoad from "@site/src/components/yamlLoad"
+import AddressSchema from "!!raw-loader!@site/docs/_schema/addresses/address.yaml";
+
+import AddressExample from "!!raw-loader!@site/docs/_examples/addresses/address.yaml";
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+# Address
+
+The Overture Address type is a compilation of open address datasets usually
+published by local authorized sources. In our initial release, we use the datasets
+that are collected and distributed by [OpenAdddresses](https://openaddresses.io).
+
+The initial schema for addresses is fairly simple and is expected to expand into
+more complex addressing schemes.
+
+## Feature types
+The address theme has a single feature type.
+- `address` is a point feature type representing a single address point.
+
+## Theme concepts
+
+
+<table>
+  <tbody>
+  <tr>
+    <th>Geometry Type</th>
+    <td>
+      <code>Point</code>
+    </td>
+  </tr>
+  <tr>
+    <th>Theme</th>
+    <td><code>addresses</code></td>
+  </tr>
+  <tr>
+    <th>Type</th>
+    <td><code>address</code></td>
+  </tr>
+  </tbody>
+</table>
+
+
+## Schema
+
+<Tabs>
+  <TabItem value="browsable" label="Browsable" default>
+    <JSONSchemaViewer schema={ yamlLoad(AddressSchema) } resolverOptions={ generateResolverOptions({remote: true, yamlBasePath: '/addresses'})}/>
+  </TabItem>
+  <TabItem value="yaml" label="YAML" default>
+    <CodeBlock language="jsx">{AddressSchema}</CodeBlock>
+  </TabItem>
+</Tabs>
+
+## Examples
+
+<Tabs>
+  <TabItem value="1" label="Address Example" default>
+    <CodeBlock language="json">{ JSON.stringify(yamlLoad(AddressExample), null, 2) }</CodeBlock>
+  </TabItem>
+</Tabs>
diff --git a/docusaurus/docs/schema/reference/divisions/division.mdx b/docusaurus/docs/schema/reference/divisions/division.mdx
@@ -40,14 +40,18 @@ A division is a recognized official or non-official organization of people as se
 
 ## Subtypes
 
-A division may include one of the following subtypes:
+While the schema for the divisions theme contains an comprehensive list of subtypes, only a subset are available in the data today.
+
+Currently, the following subtypes are available in the `division` feature type:
 
 - `country`
+- `dependency`
 - `region`
 - `county`
 - `localadmin`
 - `locality`
 - `neighborhood`
+- `microhood`
 
 <Tabs>
   <TabItem value="country" label="country" default>
@@ -64,6 +68,21 @@ A division may include one of the following subtypes:
 A country is the largest unit of independent sovereignty. The border of a country, if known, is given by [division boundary](/schema/reference/divisions/division_boundary) features. Example: United States
 
   </TabItem>
+<TabItem value="dependency" label="dependency" default>
+    <table>
+      <tbody>
+      <tr>
+        <th><code>subtype</code></th>
+        <td><code>dependency</code></td>
+      </tr>
+      </tbody>
+    </table>
+
+
+ A dependency is a place that is not exactly a sub-region of a country but is dependent on a parent country for defense, passport control, etc. Example: Puerto Rico
+
+  </TabItem>
+
 
   <TabItem value="region" label="region">
     <table>
@@ -133,6 +152,20 @@ A locality is a populated place that may or may not have its own administrative
 
 A neighborhood is a geographically localized community within a city, town, suburb or rural area, sometimes consisting of a single street and the buildings lining it. Example: Cobble Hill
   </TabItem>
+
+<TabItem value="microhood" label="microhood" default>
+    <table>
+      <tbody>
+      <tr>
+        <th><code>subtype</code></th>
+        <td><code>microhood</code></td>
+      </tr>
+      </tbody>
+    </table>
+
+
+A microhood is a mini-neighborhood that is contained within a neighborhood. Example: Gätjensort in Hamburg
+  </TabItem>  
 </Tabs>
 
 

diff --git a/docusaurus/docs/schema/reference/divisions/division_area.mdx b/docusaurus/docs/schema/reference/divisions/division_area.mdx
@@ -14,7 +14,7 @@ import division_area_example_region_land from '!!raw-loader!@site/docs/_examples
 import division_area_example_country_maritime from '!!raw-loader!@site/docs/_examples/divisions/division_area/country_maritime.yaml';
 
 
-# Division Area
+# Division area
 
 A division area is a polygon that represents the land or maritime area associated with a [division](/schema/reference/divisions/division).
 
@@ -38,13 +38,16 @@ A division area is a polygon that represents the land or maritime area associate
 
 ## Subtypes
 
-Like a division, a division area may have one of following subtypes:
+While the schema for the divisions theme contains an comprehensive list of subtypes, only a subset are available in the data today.
+
+Currently, the following subtypes are available in the `division_area` feature type:
 
 - `country`
+- `dependency`
 - `region`
 - `county`
-- `locality`
 - `localadmin`
+- `locality`
 - `neighborhood`
 
 <Tabs>
@@ -63,6 +66,21 @@ A country is the largest unit of independent sovereignty. The border of a countr
 
   </TabItem>
 
+  <TabItem value="dependency" label="dependency" default>
+    <table>
+      <tbody>
+      <tr>
+        <th><code>subtype</code></th>
+        <td><code>dependency</code></td>
+      </tr>
+      </tbody>
+    </table>
+
+
+ A dependency is a place that is not exactly a sub-region of a country but is dependent on a parent country for defense, passport control, etc. Example: Puerto Rico
+
+  </TabItem>
+
   <TabItem value="region" label="region">
     <table>
       <tbody>

diff --git a/docusaurus/docs/schema/reference/divisions/division_boundary.mdx b/docusaurus/docs/schema/reference/divisions/division_boundary.mdx
@@ -13,7 +13,7 @@ import divisions_disputed_boundary_example_both from '!!raw-loader!@site/docs/_e
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-# Division Boundary
+# Division boundary
 
 A division boundary is a border between [divisions](/schema/reference/divisions/division).
 
@@ -41,6 +41,62 @@ geopolitical issues, some boundaries represent standalone
 disputed or treaty lines and therefore do not coincide with the border
 of a division.
 
+## Subtypes
+
+While the schema for the divisions theme contains an comprehensive list of subtypes, only a subset are available in the data today.
+
+Currently, the following subtypes are available in the `division_boundary` feature type:
+
+- `country`
+- `region`
+- `county`
+
+<Tabs>
+  <TabItem value="country" label="country" default>
+    <table>
+      <tbody>
+      <tr>
+        <th><code>subtype</code></th>
+        <td><code>country</code></td>
+      </tr>
+      </tbody>
+    </table>
+
+
+A country is the largest unit of independent sovereignty. The border of a country, if known, is given by [divsion boundary](/schema/reference/divisions/division_boundary) features. Example: United States
+
+  </TabItem>
+
+  <TabItem value="region" label="region">
+    <table>
+      <tbody>
+      <tr>
+        <th><code>subtype</code></th>
+        <td><code>region</code></td>
+      </tr>
+      </tbody>
+    </table>
+
+A region is the largest administrative unit within most countries and a first-level administrative subdivision. Example: Alberta
+  </TabItem>
+
+  <TabItem value="county" label="county" default>
+    <table>
+      <tbody>
+      <tr>
+        <th><code>subtype</code></th>
+        <td><code>county</code></td>
+      </tr>
+      </tbody>
+    </table>
+
+
+A county is a second-level administrative subdivision. Example: Kings County, NY
+  </TabItem>
+
+</Tabs>
+
+
 ## Schema
 
 <Tabs>