Reorganise

ideal-postcodes · Mar 8, 2024 · bf3a033 · bf3a033
1 parent 5e873b2
commit bf3a033
Show file tree

Hide file tree

Showing 23 changed files with 86 additions and 79 deletions.
diff --git a/docs/docs/methods/postcode-validation.mdx b/docs/docs/methods/postcode-validation.mdx
diff --git a/docs/docs/methods/outward-code-lookup.mdx → docs/docs/outcode/lookup.mdx b/docs/docs/methods/outward-code-lookup.mdx → docs/docs/outcode/lookup.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Outcode Lookup"
-title: "Outcode Lookup"
+sidebar_label: "Lookup"
+title: "Lookup an Outward Code"
 ---
 
 Geolocation data for the centroid of the outward code specified. The outward code represents the first half of any postcode (separated by a space).

diff --git a/docs/docs/methods/nearest-outcode.mdx → docs/docs/outcode/nearest.mdx b/docs/docs/methods/nearest-outcode.mdx → docs/docs/outcode/nearest.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Nearest Outcode"
-title: "Nearest Outcode"
+sidebar_label: "Nearest"
+title: "Retrieve Nearest Outward Code"
 ---
 
 Returns nearest outcodes for a given outcode.

diff --git a/...ocs/methods/outcode-reverse-geocoding.mdx → docs/docs/outcode/reverse-geocode.mdx b/...ocs/methods/outcode-reverse-geocoding.mdx → docs/docs/outcode/reverse-geocode.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Outcode Reverse Geocoding"
-title: "Outcode Reverse Geocoding"
+sidebar_label: "Reverse Geocode"
+title: "Reverse Geocode an Outcode"
 ---
 
 Returns nearest outcodes for a given longitude and latitude.

diff --git a/docs/docs/data-fields/outcode.mdx → docs/docs/outcode/schema.mdx b/docs/docs/data-fields/outcode.mdx → docs/docs/outcode/schema.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Outcode Data"
-title: "Outcode Data (Ordnance Survey Postcode Directory Dataset)"
+sidebar_label: "Schema"
+title: "Outward Code Schema"
 ---
 
 Data Returned by the `/outcodes` API

diff --git a/docs/docs/methods/place-lookup.mdx → docs/docs/place/lookup.mdx b/docs/docs/methods/place-lookup.mdx → docs/docs/place/lookup.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Place Lookup"
-title: "Place Lookup"
+sidebar_label: "Lookup"
+title: "Lookup a GB Place"
 ---
 
 Find a place by OSGB code (e.g. "osgb4000000074564391"). Returns all available data if found. Returns 404 if place does not exist.

diff --git a/docs/docs/methods/place-query.mdx → docs/docs/place/query.mdx b/docs/docs/methods/place-query.mdx → docs/docs/place/query.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Place Query"
-title: "Place Query"
+sidebar_label: "Query"
+title: "Query for GB place"
 ---
 
 Submit a place query and receive a complete list of places matches and associated data.

diff --git a/docs/docs/methods/random-place.mdx → docs/docs/place/random.mdx b/docs/docs/methods/random-place.mdx → docs/docs/place/random.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Random Place"
-title: "Random Place"
+sidebar_label: "Random"
+title: "Retrieve a Random Place"
 ---
 
 Returns a random place and all associated data

diff --git a/docs/docs/data-fields/places.mdx → docs/docs/place/schema.mdx b/docs/docs/data-fields/places.mdx → docs/docs/place/schema.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Places Data"
-title: "Places Data (Ordnance Survey Open Names Dataset)"
+sidebar_label: "Schema"
+title: "Places Schema"
 ---
 
 Data Returned by the `/places` API

diff --git a/docs/docs/methods/postcode-autocomplete.mdx → docs/docs/postcode/autocomplete.mdx b/docs/docs/methods/postcode-autocomplete.mdx → docs/docs/postcode/autocomplete.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Postcode Autocomplete"
-title: "Postcode Autocomplete"
+sidebar_label: "Autocomplete"
+title: "Autocomplete a Postcode"
 ---
 
 Convenient method to return an list of matching postcodes.

diff --git a/docs/docs/methods/bulk-reverse-geocoding.mdx → docs/docs/postcode/bulk-reverse-geocode.mdx b/docs/docs/methods/bulk-reverse-geocoding.mdx → docs/docs/postcode/bulk-reverse-geocode.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Bulk Reverse Geocoding"
-title: "Bulk Reverse Geocoding"
+sidebar_label: "Bulk Reverse Geocode"
+title: "Bulk Reverse Geocode Postcodes"
 ---
 
 Bulk translates geolocations into Postcodes. Accepts up to 100 geolocations.

diff --git a/docs/docs/methods/bulk-postcode-lookup.mdx → docs/docs/postcode/bulk.mdx b/docs/docs/methods/bulk-postcode-lookup.mdx → docs/docs/postcode/bulk.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Bulk Postcode Lookup"
-title: "Bulk Postcode Lookup"
+sidebar_label: "Bulk Lookup"
+title: "Bulk Lookup Postcodes"
 ---
 
 Accepts a JSON object containing an array of postcodes. Returns a list of matching postcodes and respective available data.
@@ -19,7 +19,7 @@ This method requires a JSON object containing an array of postcodes to be posted
 
 ```JSON
 {
-    "postcodes" : ["PR3 0SG", "M45 6GN", "EX165BL"]
+  "postcodes" : ["PR3 0SG", "M45 6GN", "EX165BL"]
 }
 ```
 

diff --git a/docs/docs/methods/postcode-lookup.mdx → docs/docs/postcode/lookup.mdx b/docs/docs/methods/postcode-lookup.mdx → docs/docs/postcode/lookup.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Postcode Lookup"
-title: "Postcode Lookup"
+sidebar_label: "Lookup"
+title: "Lookup a Postcode"
 ---
 
 This uniquely identifies a postcode.

diff --git a/docs/docs/methods/nearest-postcode.mdx → docs/docs/postcode/nearest.mdx b/docs/docs/methods/nearest-postcode.mdx → docs/docs/postcode/nearest.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Nearest Postcode"
-title: "Nearest Postcode"
+sidebar_label: "Nearest"
+title: "Find Nearest Postcode"
 ---
 
 Returns nearest postcodes for a given postcode.

diff --git a/docs/docs/methods/postcode-query.mdx → docs/docs/postcode/query.mdx b/docs/docs/methods/postcode-query.mdx → docs/docs/postcode/query.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Postcode Query"
-title: "Postcode Query"
+sidebar_label: "Query"
+title: "Query for a Postcode"
 ---
 
 Submit a postcode query and receive a complete list of postcode matches and all associated postcode data.

diff --git a/docs/docs/methods/random-postcode.mdx → docs/docs/postcode/random.mdx b/docs/docs/methods/random-postcode.mdx → docs/docs/postcode/random.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Random Postcode"
-title: "Random Postcode"
+sidebar_label: "Random"
+title: "Retrieve a Random Postcode"
 ---
 
 Returns a random postcode and all available data for that postcode.

diff --git a/docs/docs/methods/reverse-geocoding.mdx → docs/docs/postcode/reverse-geocode.mdx b/docs/docs/methods/reverse-geocoding.mdx → docs/docs/postcode/reverse-geocode.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Reverse Geocoding"
-title: "Reverse Geocoding"
+sidebar_label: "Reverse Geocode"
+title: "Reverse Geocode a Postcode"
 ---
 
 Returns nearest postcodes for a given longitude and latitude.

diff --git a/docs/docs/data-fields/postcode.mdx → docs/docs/postcode/schema.mdx b/docs/docs/data-fields/postcode.mdx → docs/docs/postcode/schema.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Postcode Data"
-title: "Postcode Data (Ordnance Survey Postcode Directory Dataset)"
+sidebar_label: "Schema"
+title: "Postcode Model"
 ---
 
 Data Points Returned by the `/postcodes` and `/outcodes` API

diff --git a/...docs/methods/scottish-postcode-lookup.mdx → docs/docs/scottish-postcode/lookup.mdx b/...docs/methods/scottish-postcode-lookup.mdx → docs/docs/scottish-postcode/lookup.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Scottish Postcode Lookup"
-title: "Scottish Postcode Lookup"
+sidebar_label: "Lookup"
+title: "Lookup a Scottish Postcode"
 ---
 
 Lookup a Scottish postcode. Returns SPD data associated with postcode. At the moment this is just Scottish Parliamentary Constituency.

diff --git a/docs/docs/data-fields/scottish.mdx → docs/docs/scottish-postcode/schema.mdx b/docs/docs/data-fields/scottish.mdx → docs/docs/scottish-postcode/schema.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Scottish Postcode Data"
-title: "Scottish Postcode Data (Scottish Postcode Directory)"
+sidebar_label: "Schema"
+title: "Scottish Postcode Schema"
 ---
 
 Data Returned by the `/scotland/*` APIs

diff --git a/...cs/methods/terminated-postcode-lookup.mdx → docs/docs/terminated-postcode/lookup.mdx b/...cs/methods/terminated-postcode-lookup.mdx → docs/docs/terminated-postcode/lookup.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Terminated Postcode Lookup"
-title: "Terminated Postcode Lookup"
+sidebar_label: "Lookup"
+title: "Lookup a Terminated Postcode"
 ---
 
 Lookup a terminated postcode. Returns the postcode, year and month of termination. Returns 404 if postcode does not exist in our database of terminated postcodes or not valid.

diff --git a/docs/docs/data-fields/terminated.mdx → docs/docs/terminated-postcode/schema.mdx b/docs/docs/data-fields/terminated.mdx → docs/docs/terminated-postcode/schema.mdx
@@ -1,6 +1,6 @@
 ---
-sidebar_label: "Terminated Postcode Data"
-title: "Terminated Postcode Data (Ordnance Survey Postcode Directory Dataset)"
+sidebar_label: "Schema"
+title: "Terminated Postcode Schema"
 ---
 
 Data Returned by the `/terminated_postcodes/*` APIs

diff --git a/docs/sidebars.ts b/docs/sidebars.ts
@@ -21,38 +21,57 @@ const sidebars: SidebarsConfig = {
     "self-host",
     {
       type: "category",
-      label: "Available Data Fields",
+      label: "Postcodes",
       collapsed: false,
       items: [
-        "data-fields/postcode",
-        "data-fields/outcode",
-        "data-fields/scottish",
-        "data-fields/terminated",
-        "data-fields/places",
+        "postcode/schema",
+        "postcode/lookup",
+        "postcode/query",
+        "postcode/bulk",
+        "postcode/random",
+        "postcode/autocomplete",
+        "postcode/reverse-geocode",
+        "postcode/bulk-reverse-geocode",
       ],
     },
     {
       type: "category",
-      label: "Methods",
+      label: "Outward Codes",
       collapsed: false,
       items: [
-        "methods/postcode-lookup",
-        "methods/bulk-postcode-lookup",
-        "methods/reverse-geocoding",
-        "methods/bulk-reverse-geocoding",
-        "methods/postcode-query",
-        "methods/postcode-validation",
-        "methods/nearest-postcode",
-        "methods/postcode-autocomplete",
-        "methods/random-postcode",
-        "methods/outward-code-lookup",
-        "methods/outcode-reverse-geocoding",
-        "methods/nearest-outcode",
-        "methods/scottish-postcode-lookup",
-        "methods/terminated-postcode-lookup",
-        "methods/place-lookup",
-        "methods/place-query",
-        "methods/random-place",
+        "outcode/schema",
+        "outcode/lookup",
+        "outcode/reverse-geocode",
+        "outcode/nearest",
+      ],
+    },
+    {
+      type: "category",
+      label: "Places",
+      collapsed: false,
+      items: [
+        "place/schema",
+        "place/lookup",
+        "place/query",
+        "place/random",
+      ],
+    },
+    {
+      type: "category",
+      label: "Terminated Postcodes",
+      collapsed: false,
+      items: [
+        "terminated-postcode/schema",
+        "terminated-postcode/lookup",
+      ],
+    },
+    {
+      type: "category",
+      label: "Scottish Postcodes",
+      collapsed: false,
+      items: [
+        "scottish-postcode/schema",
+        "scottish-postcode/lookup",
       ],
     },
   ],