rustprooflabs · rustprooflabs · Feb 3, 2023 · Feb 3, 2023
diff --git a/README.md b/README.md
@@ -5,106 +5,10 @@ osm2pgsql Flex output.
 See [https://pgosm-flex.com/](https://pgosm-flex.com/) for the main project
 documentation.
 
+> If the custom domain is not working, try [https://rustprooflabs.github.io/pgosm-flex/index.html](https://rustprooflabs.github.io/pgosm-flex/index.html). If everything is working this link will redirect to the custom domain.
 
 
+See [./docs/README.md](./docs/README.md) for instructions to build and view
+the documentation locally.
 
-## Explore data loaded
 
-A peek at some of the tables loaded.
-This query requires the
-[PostgreSQL Data Dictionary (PgDD) extension](https://github.com/rustprooflabs/pgdd),
-use `\dt+ osm.*` in `psql` for similar details.
-
-
-```sql
-SELECT s_name, t_name, rows, size_plus_indexes 
-    FROM dd.tables 
-    WHERE s_name = 'osm' 
-    ORDER BY t_name LIMIT 10;
-```
-
-```bash
-    ┌────────┬──────────────────────┬────────┬───────────────────┐
-    │ s_name │        t_name        │  rows  │ size_plus_indexes │
-    ╞════════╪══════════════════════╪════════╪═══════════════════╡
-    │ osm    │ amenity_line         │      7 │ 56 kB             │
-    │ osm    │ amenity_point        │   5796 │ 1136 kB           │
-    │ osm    │ amenity_polygon      │   7593 │ 3704 kB           │
-    │ osm    │ building_point       │    525 │ 128 kB            │
-    │ osm    │ building_polygon     │ 161256 │ 55 MB             │
-    │ osm    │ indoor_line          │      1 │ 40 kB             │
-    │ osm    │ indoor_point         │      5 │ 40 kB             │
-    │ osm    │ indoor_polygon       │    288 │ 136 kB            │
-    │ osm    │ infrastructure_point │    884 │ 216 kB            │
-    │ osm    │ landuse_point        │     18 │ 56 kB             │
-    └────────┴──────────────────────┴────────┴───────────────────┘
-```
-
-
-
-
-## Query examples
-
-For example queries with data loaded by PgOSM-Flex see
-[docs/QUERY.md](docs/QUERY.md).
-
-
-
-## One table to rule them all
-
-From the perspective of database design, the `osm.unitable` option is the **worst**!
-This table violates all sorts of best practices established in this project
-by shoving all features into a single unstructured table.
-
-> This style included in PgOSM Flex is intended to be used for troubleshooting and quality control.  It is not intended to be used for real production workloads! This table is helpful for exploring the full data set when you don't really know what you are looking for, but you know **where** you are looking.
-
-Unitable is loaded with the `everything` layerset.  Feel free to create your own
-customized layerset if needed.
-
-
-
-```bash
-docker exec -it \
-    pgosm python3 docker/pgosm_flex.py \
-    --ram=8 \
-    --region=north-america/us \
-    --subregion=district-of-columbia \
-    --layerset=everything
-```
-
-
-> The `unitable.lua` script include in in this project was [adapted from the unitable example from osm2pgsql](https://github.com/openstreetmap/osm2pgsql/blob/master/flex-config/unitable.lua). This version uses JSONB instead of HSTORE and takes advantage of `helpers.lua` to easily customize SRID.
-
-
-## JSONB support
-
-PgOSM-Flex uses `JSONB` in Postgres to store the raw OpenStreetMap
-key/value data (`tags` column) and relation members (`member_ids`).
-The `tags` column only exists in the `osm.tags` and `osm.unitable` tables.
-The `member_ids` column is included in:
-
-* `osm.place_polygon`
-* `osm.poi_polygon`
-* `osm.public_transport_line`
-* `osm.public_transport_polygon`
-* `osm.road_line`
-* `osm.road_major`
-* `osm.road_polygon`
-
-
-
-
-## Projects using PgOSM Flex
-
-
-See the listing of known [projects using PgOSM Flex](docs/PROJECTS.md).
-
-
-## Additional resources
-
-
-Blog posts covering various details and background information.
-
-* [Better OpenStreetMap places in PostGIS](https://blog.rustprooflabs.com/2021/01/pgosm-flex-improved-openstreetmap-places-postgis)
-* [Improved OpenStreetMap data structure in PostGIS](https://blog.rustprooflabs.com/2021/01/postgis-openstreetmap-flex-structure) 
-* [Hands on with osm2pgsql's new Flex output](https://blog.rustprooflabs.com/2020/12/osm2gpsql-flex-output-to-postgis).
diff --git a/CODE_OF_CONDUCT.md → docs/src/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md → docs/src/CODE_OF_CONDUCT.md
diff --git a/CONTRIBUTING.md → docs/src/CONTRIBUTING.md b/CONTRIBUTING.md → docs/src/CONTRIBUTING.md
@@ -18,5 +18,5 @@ Checklist for adding new feature layers:
 * Update `flex-config/run-no-tags.lua`
 * Update `flex-config/run-no-tags.sql`
 * Update `db/qc/features_not_in_run_all.sql`
-* Add relevent `tests/sql/<feature_queries>.sql`
-* Add relevent `tests/expected/<feature_queries>.out`
+* Add relevant `tests/sql/<feature_queries>.sql`
+* Add relevant `tests/expected/<feature_queries>.out`
diff --git a/docs/src/QUICK-START.md b/docs/src/QUICK-START.md
@@ -159,3 +159,97 @@ SELECT osm_date, region, srid,
 │ 2022-11-25 │ north-america/us-colorado │ 3857 │ 0.6.2-e1f140f      │ 1.7.2             │ append         │
 └────────────┴───────────────────────────┴──────┴────────────────────┴───────────────────┴────────────────┘
 ```
+
+
+
+## Explore data loaded
+
+A peek at some of the tables loaded.
+This query requires the
+[PostgreSQL Data Dictionary (PgDD) extension](https://github.com/rustprooflabs/pgdd),
+use `\dt+ osm.*` in `psql` for similar details.
+
+
+```sql
+SELECT s_name, t_name, rows, size_plus_indexes 
+    FROM dd.tables 
+    WHERE s_name = 'osm' 
+    ORDER BY t_name LIMIT 10;
+```
+
+```bash
+    ┌────────┬──────────────────────┬────────┬───────────────────┐
+    │ s_name │        t_name        │  rows  │ size_plus_indexes │
+    ╞════════╪══════════════════════╪════════╪═══════════════════╡
+    │ osm    │ amenity_line         │      7 │ 56 kB             │
+    │ osm    │ amenity_point        │   5796 │ 1136 kB           │
+    │ osm    │ amenity_polygon      │   7593 │ 3704 kB           │
+    │ osm    │ building_point       │    525 │ 128 kB            │
+    │ osm    │ building_polygon     │ 161256 │ 55 MB             │
+    │ osm    │ indoor_line          │      1 │ 40 kB             │
+    │ osm    │ indoor_point         │      5 │ 40 kB             │
+    │ osm    │ indoor_polygon       │    288 │ 136 kB            │
+    │ osm    │ infrastructure_point │    884 │ 216 kB            │
+    │ osm    │ landuse_point        │     18 │ 56 kB             │
+    └────────┴──────────────────────┴────────┴───────────────────┘
+```
+
+
+
+
+
+
+## One table to rule them all
+
+From the perspective of database design, the `osm.unitable` option is the **worst**!
+This table violates all sorts of best practices established in this project
+by shoving all features into a single unstructured table.
+
+> This style included in PgOSM Flex is intended to be used for troubleshooting and quality control.  It is not intended to be used for real production workloads! This table is helpful for exploring the full data set when you don't really know what you are looking for, but you know **where** you are looking.
+
+Unitable is loaded with the `everything` layerset.  Feel free to create your own
+customized layerset if needed.
+
+
+
+```bash
+docker exec -it \
+    pgosm python3 docker/pgosm_flex.py \
+    --ram=8 \
+    --region=north-america/us \
+    --subregion=district-of-columbia \
+    --layerset=everything
+```
+
+
+> The `unitable.lua` script include in in this project was [adapted from the unitable example from osm2pgsql](https://github.com/openstreetmap/osm2pgsql/blob/master/flex-config/unitable.lua). This version uses JSONB instead of HSTORE and takes advantage of `helpers.lua` to easily customize SRID.
+
+
+## JSONB support
+
+PgOSM-Flex uses `JSONB` in Postgres to store the raw OpenStreetMap
+key/value data (`tags` column) and relation members (`member_ids`).
+The `tags` column only exists in the `osm.tags` and `osm.unitable` tables.
+The `member_ids` column is included in:
+
+* `osm.place_polygon`
+* `osm.poi_polygon`
+* `osm.public_transport_line`
+* `osm.public_transport_polygon`
+* `osm.road_line`
+* `osm.road_major`
+* `osm.road_polygon`
+
+
+
+## Additional resources
+
+
+Blog posts covering various details and background information.
+
+* [Book Release! Mastering PostGIS and OpenStreetMap](https://blog.rustprooflabs.com/2022/10/announce-mastering-postgis-openstreemap)
+* [Better OpenStreetMap places in PostGIS](https://blog.rustprooflabs.com/2021/01/pgosm-flex-improved-openstreetmap-places-postgis)
+* [Improved OpenStreetMap data structure in PostGIS](https://blog.rustprooflabs.com/2021/01/postgis-openstreetmap-flex-structure) 
+* [Hands on with osm2pgsql's new Flex output](https://blog.rustprooflabs.com/2020/12/osm2gpsql-flex-output-to-postgis).
+
+
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -1,6 +1,8 @@
 # Summary
 
 [About PgOSM Flex](README.md)
+[Code of Conduct](./CODE_OF_CONDUCT.md)
+[Contributing to PgOSM Flex](./CONTRIBUTING.md)
 
 # User Guide