Publish draft pages because they add value, restructure menu a bit an…

…d fix broken links
Netherlands3D · Sep 18, 2024 · af4151a · af4151a
1 parent 139c7f8
commit af4151a
Show file tree

Hide file tree

Showing 10 changed files with 37 additions and 34 deletions.
diff --git a/docs/docs/developers/architecture.md b/docs/docs/developers/architecture.md
diff --git a/docs/docs/developers/configuration.md b/docs/docs/developers/configuration.md
@@ -1,4 +1,4 @@
-The Netherlands3D platform has a modular configuration system in which [functionalities](features/index.md) in the 
+The Netherlands3D platform has a modular configuration system in which [functionalities](functionalities.md) in the 
 application can register their own per-deployment defaults and settings. This can be used to -for example- pre-package 
 API Keys and server URLs when deploying the application.
 
@@ -86,7 +86,7 @@ Functionalities always follow this format:
 ```
 
 In the snippet above, `[CODE]` can be substituted with the functionality code string as defined in the application -more
-on how to find this in the documentation on [functionalities](features/index.md). 
+on how to find this in the documentation on [functionalities](functionalities.md). 
 
 `enabled` represents a boolean whether the functionality is enabled in the application or not and the `configuration`
 json object represents the means to provide additional configuration for that functionality. If there is no additional

diff --git a/docs/docs/developers/core-concepts.md b/docs/docs/developers/core-concepts.md
@@ -82,7 +82,7 @@ infrastructure.
 
 ### Features in Rasterlayers: The Hybrid Approach
 
-Traditionally, Rasterlayers—such as overlay images or heatmaps—do not contain discrete features. They represent
+Traditionally, Rasterlayers —such as overlay images or heatmaps— do not contain discrete features. They represent
 continuous data spread across a grid, where each cell or pixel has a value but is not individually distinguished as a
 feature. However, with advances in 3D mapping technology, a new hybrid approach has emerged.
 

diff --git a/docs/docs/developers/features/geojson.md b/docs/docs/developers/features/geojson.md
@@ -1,23 +1,31 @@
-GeoJSON in Netherlands3D
-=======================================
-
-## GeoJSON import
+GeoJSON Support
+===============
 
 Netherlands3D offers limited support for importing GeoJSON data. The functionality is still being expanded.
 
 ## Features
-- Currently only GeoJSON files are supported. The default file extensions are .json or .geojson. In case custom file types should be supported, these can be added in the FileOpen script (to allow selection of other file types) and in the FileTypeAdapter (to process the opened file).
-- The GeoJSON parsing is spread over multiple frames, (default is max 0.01s of parsing per frame) as to not freeze the application when importing large files. This duration can be changed by changing the variable `maxParseDuration` in GeoJSONLayer.cs
+
+- Currently only GeoJSON files are supported. The default file extensions are .json or .geojson. In case custom file
+  types should be supported, these can be added in the FileOpen script (to allow selection of other file types) and in
+  the FileTypeAdapter (to process the opened file).
+- The GeoJSON parsing is spread over multiple frames, (default is max 0.01s of parsing per frame) as to not freeze the
+  application when importing large files. This duration can be changed by changing the variable `maxParseDuration` in
+  GeoJSONLayer.cs
 - GeoJSON features of type Polygon, MultiPolygon, LineString, MultiLineString, Point, and MultiPoint are supported.
-- GeoJSON coordinates are passed to the [`eu.netherlands3d.coordinates`](https://openupm.com/packages/eu.netherlands3d.coordinates/) package using the parsed CRS in order to convert them to Unity coordinates (see also the section on limitations for CRS limitations). A CRS object of type `Linked CRS` is currently not supported
+- GeoJSON coordinates are passed to
+  the [`eu.netherlands3d.coordinates`](https://openupm.com/packages/eu.netherlands3d.coordinates/) package using the
+  parsed CRS in order to convert them to Unity coordinates (see also the section on limitations for CRS limitations). A
+  CRS object of type `Linked CRS` is currently not supported
 - A material can be assigned to the GeoJSONLayer that determines the appearance of the visualization.
 - An event is invoked when parsing fails, to allow for display of error messages on screen.
 
 ## Limitations
 
 The GeoJSON support currently has the following limitations:
 
-- A LinkedCRS object is parsed correctly in the GeoJSONLayer, however it is currently not interpreted to provide a valid input for the visualization through the [`eu.netherlands3d.coordinates`](https://openupm.com/packages/eu.netherlands3d.coordinates/) package.
+- A LinkedCRS object is parsed correctly in the GeoJSONLayer, however it is currently not interpreted to provide a valid
+  input for the visualization through
+  the [`eu.netherlands3d.coordinates`](https://openupm.com/packages/eu.netherlands3d.coordinates/) package.
 - All features of the Type Polygon and MultiPolygon are combined to form 1 layer in the application
-- All features of the Type LineString and MultiLinstring are combined to form 1 layer in the application
+- All features of the Type LineString and MultiLineString are combined to form 1 layer in the application
 - All features of the Type Point and MultiPoint are combined to form 1 layer in the application
diff --git a/docs/docs/developers/features/index.md → docs/docs/developers/functionalities.md b/docs/docs/developers/features/index.md → docs/docs/developers/functionalities.md
@@ -11,7 +11,7 @@ your project.
 ## Configuring Functionalities
 
 Furthermore, each functionality can be individually configured according to specific project requirements. Read more
-about this in detail in the chapter about [configuration](../configuration.md).
+about this in detail in the chapter about [configuration](configuration.md).
 
 Through additional configuration settings, you have the flexibility to adjust the functionality's behavior and
 characteristics to match your project's needs. You'll have access to a broad range of settings allowing you to refine

diff --git a/...rs/features/layers-with-authentication.md → .../developers/layers-with-authentication.md b/...rs/features/layers-with-authentication.md → .../developers/layers-with-authentication.md
diff --git a/docs/docs/developers/features/layers.md → docs/docs/developers/layers.md b/docs/docs/developers/features/layers.md → docs/docs/developers/layers.md
@@ -1,5 +1,5 @@
-Layers in Netherlands3D
-=======================================
+Layers
+======
 
 ## Layers
 

diff --git a/docs/docs/developers/packages/index.md → ...elopers/packages/creating-and-managing.md b/docs/docs/developers/packages/index.md → ...elopers/packages/creating-and-managing.md
@@ -72,7 +72,7 @@ needs to be made- and follows the following sequence of steps:
 3. Check and adjust, at least, the URL's for the LICENSE, README and CHANGELOG in the `package.json`.
 
 4. Release and publish the promoted package, see the chapters on [releasing](#releasing-a-package) and 
-   [publishing](#publishing-a-package) for the involved steps.
+   [publishing](#publishing-a-package-on-openupm) for the involved steps.
 
 5. In the Twin project, add a reference to `{PACKAGE_NAME}` to the package.json or install the package through
    the package manager.

diff --git a/docs/docs/developers/projects.md b/docs/docs/developers/projects.md
@@ -59,6 +59,11 @@ residual configurations from previous projects.
 
 ## How Layers Work
 
+!!! tip inline end "Self-registering layers"
+
+    A variant of the described flow exists where by adding the visualisation of a layer it self-registers the layer's
+    data onto the current project. This flow will be described in a separate chapter for clarity.
+
 ![how layers work](../imgs/how-layers-work-in-a-project.png)
 
 The diagram provided illustrates the lifecycle of layers within a project, detailing how they are acquired,

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -8,17 +8,19 @@ nav:
 #      - 'docs/organisations/personalisering.md'
   - 'Voor ontwikkelaars':
       - 'docs/developers/quickstart.md'
-#      - 'docs/developers/architecture.md'
+      - 'docs/developers/core-concepts.md'
       - 'docs/developers/configuration.md'
-      - 'Functionalities':
-          - 'docs/developers/features/index.md'
+      - 'Structure':
+          - 'docs/developers/projects.md'
+          - 'docs/developers/functionalities.md'
+          - 'docs/developers/layers.md'
+          - 'docs/developers/layers-with-authentication.md'
+      - 'Features':
           - 'docs/developers/features/embedding.md'
           - 'docs/developers/features/floating-origin.md'
-          - 'docs/developers/features/layers.md'
-          - 'docs/developers/features/layers-with-authentication.md'
           - 'docs/developers/features/geojson.md'
       - 'Packages':
-          - 'docs/developers/packages/index.md'
+          - 'docs/developers/packages/creating-and-managing.md'
       - 'User interface':
           - 'docs/developers/ui/introduction.md'
           - 'docs/developers/ui/keeping-our-documentation-current.md'
@@ -45,7 +47,6 @@ nav:
 # https://www.mkdocs.org/user-guide/configuration/#draft_docs
 draft_docs: |
   about-us/index.md
-  docs/developers/architecture.md
   docs/developers/ui/locating-components-in-unity.md
   docs/organisations/getting-started.md
   docs/organisations/hosting.md
@@ -54,8 +55,6 @@ draft_docs: |
 # Includes, starting with an underscore - https://www.mkdocs.org/user-guide/configuration/#not_in_nav
 not_in_nav: |
   _*.md
-  docs/developers/core-concepts.md
-  docs/developers/projects.md
 
 site_name: "" # Empty on purpose for style purposes
 theme: