chore: added explanation placeholders

_quarto.yml

@@ -24,6 +24,8 @@ website:
     left:
       - href: docs/getting_started.qmd
         text: Getting Started
+      - href: docs/explanation/index.qmd
+        text: Explanation
       - href: docs/tutorials/index.qmd
         text: Tutorials
       - href: docs/reference/index.qmd
@@ -42,6 +44,12 @@ website:
     contents:
       - text: Getting Started
         href: docs/getting_started.qmd
+      - section: Explanation
+        href: docs/explanation/index.qmd
+        contents:
+          - "docs/explanation/what_is_tp/index.qmd"
+          - "docs/explanation/calculate_tp/index.qmd"
+          - "docs/explanation/limitations/index.qmd"
       - section: Tutorials
         href: docs/tutorials/index.qmd
         contents:

docs/explanation/calculate_tp/index.qmd

@@ -0,0 +1,10 @@
+---
+title: "Transport Performance: An Example"
+description: An overview of how we used `transport_performance` to calculate the transport performance of urban centre public transit networks.
+date-modified: 05/16/2024  # must be in MM/DD/YYYY format
+categories: ["Explanation"]  # see https://diataxis.fr/tutorials-how-to/#tutorials-how-to, delete as appropriate
+toc: true
+date-format: iso
+---
+
+🚧 Page under construction 🚧

docs/explanation/index.qmd

@@ -0,0 +1,13 @@
+---
+title: Explanation
+listing:
+    type: table
+    contents:
+        - "/**/*.qmd"
+    fields: [title, description, reading-time]
+    sort: title desc
+    sort-ui: true
+    filter-ui: true
+---
+
+These explanation pages provide an understanding of what Transport Performance is, how it is calculated, and methodology limitations.

docs/explanation/limitations/index.qmd

@@ -0,0 +1,10 @@
+---
+title: "Limitations and Caveats"
+description: A discussion around the main `transport_performance` package limitations.
+date-modified: 05/16/2024  # must be in MM/DD/YYYY format
+categories: ["Explanation"]  # see https://diataxis.fr/tutorials-how-to/#tutorials-how-to, delete as appropriate
+toc: true
+date-format: iso
+---
+
+🚧 Page under construction 🚧

docs/explanation/what_is_tp/index.qmd

@@ -0,0 +1,10 @@
+---
+title: What is Transport Performance?
+description: An insight into what transport performance is and what it tells us about transport networks.
+date-modified: 05/16/2024  # must be in MM/DD/YYYY format
+categories: ["Explanation"]  # see https://diataxis.fr/tutorials-how-to/#tutorials-how-to, delete as appropriate
+toc: true
+date-format: iso
+---
+
+🚧 Page under construction 🚧