better org nav menu

rafaqz · Dec 28, 2024 · 07c8032 · 07c8032
1 parent bc0e64a
commit 07c8032
Show file tree

Hide file tree

Showing 9 changed files with 30 additions and 32 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -10,9 +10,9 @@ CairoMakie.activate!(type = "png")
 # Plots warnings are brWarn doctests. They don't warn the second time.
 # Downloads also show op in doctests. So download everything first.
 function flush_info_and_warnings()
-    # RasterStack(AWAP, (:tmin, :tmax); date=DateTime(2001, 1, 1))
-    # RasterStack(EarthEnv{HabitatHeterogeneity}, (:evenness, :range, :contrast, :correlation))
-    # RasterStack(WorldClim{BioClim}, (1, 3, 5, 7, 12))
+    RasterStack(AWAP, (:tmin, :tmax); date=DateTime(2001, 1, 1))
+    RasterStack(EarthEnv{HabitatHeterogeneity}, (:evenness, :range, :contrast, :correlation))
+    RasterStack(WorldClim{BioClim}, (1, 3, 5, 7, 12))
     st = RasterStack(WorldClim{Climate}; month=1);
     plot(st)
 end

diff --git a/docs/src/.vitepress/config.mts b/docs/src/.vitepress/config.mts
@@ -16,22 +16,22 @@ const navTemp = {
   nav: [
     { text: 'Home', link: '/' },
     { text: 'Get Started', link: '/get_started' },
-    { text: 'Methods',
+    { text: 'Manual',
       items: [
-        { text: 'Overview', link: '/methods' },
-        { text: 'Array Operations', link: '/array_operations' },
+        { text: 'Methods', link: '/manual/methods' },
+        { text: 'Array Operations', link: '/manual/array_operations' },
+        { text: 'Data Sources', link: '/manual/data_sources' },
+        { text: 'Plots',
+          items: [
+            { text: 'Plots.jl', link: '/manual/plotting' },
+            { text: 'Makie.jl', link: 'manual/plot_makie' },
+          ]
+        },  
       ]
     },
-    { text: 'Data Sources', link: '/data_sources' },
-    { text: 'Plots',
+    { text: 'Tutorials',
       items: [
-        { text: 'Plots.jl', link: '/plotting' },
-        { text: 'Makie.jl', link: '/plot_makie' },
-      ]
-    },  
-    { text: 'Examples',
-      items: [
-        { text: 'Species Distribution Modelling', link: '/gbif_wflow' },
+        { text: 'Species Distribution Modelling', link: '/tutorials/gbif_wflow' },
       ]
     },
     { text: 'Ecosystem',
@@ -96,29 +96,27 @@ export default defineConfig({
     nav,
     sidebar: [
       { text: 'Get Started', link: '/get_started' },
-      { text: 'Methods',
-        items: [
-          { text: 'Overview', link: '/methods' },
-          { text: 'Array Operations', link: '/array_operations' },
-        ]
-      },
-      { text: 'Data Sources', link: '/data_sources' },
-      { text: 'Plots',
+      { text: 'Manual',
         items: [
-          { text: 'Plots.jl', link: '/plotting' },
-          { text: 'Makie.jl', link: '/plot_makie' },
+          { text: 'Methods', link: '/manual/methods' },
+          { text: 'Array Operations', link: '/manual/array_operations' },
+          { text: 'Data Sources', link: '/manual/data_sources' },
+          { text: 'Plots',
+            items: [
+              { text: 'Plots.jl', link: '/manual/plotting' },
+              { text: 'Makie.jl', link: '/manual/plot_makie' },
+            ]
+          },  
         ]
       },
-      { text: 'Examples',
+      { text: 'Tutorials',
         items: [
-          { text: 'Species Distribution Modelling', link: '/gbif_wflow' },
+          { text: 'Species Distribution Modelling', link: '/tutorials/gbif_wflow' },
         ]
       },
       { text: 'API', link: '/api' }
     ],
-    editLink: {
-      pattern: 'REPLACE_ME_DOCUMENTER_VITEPRESS'
-    },
+    editLink: 'REPLACE_ME_DOCUMENTER_VITEPRESS',
     socialLinks: [
       // { icon: 'github', link: 'REPLACE_ME_DOCUMENTER_VITEPRESS' }
     ],

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -25,10 +25,10 @@ hero:
 features:
   - title: 💥💠 Core Functionality
     details: Defines common types and methods for reading, writing, and manipulating rasterized spatial data. <a class="highlight-link">Rasters.jl</a> provides unified data handling through types like <a class="highlight-link">Raster</a>, <a class="highlight-link">RasterStack</a>, and <a class="highlight-link">RasterSeries</a>, offering seamless abstraction regardless of storage backend.
-    link: /methods
+    link: /manual/methods
   - title: ⚙️ Data-Source Abstraction
     details: Rasters provides a standardized interface that enables various data source types to be used with consistent syntax. The data can include <a class="highlight-link">GeoTIFF</a> or <a class="highlight-link">NetCDF</a> files, in-memory Arrays, or <a class="highlight-link">CuArrays</a> on the <a class="highlight-link">GPU</a>—all of which will behave in the same way.
-    link: /data_sources
+    link: /manual/data_sources
   - title: 🗂️🌐 Data Formats
     details: A <a class="highlight-link">RasterStack</a> can be backed by a <a class="highlight-link">NetCDF</a> or <a class="highlight-link">HDF5</a> file, a NamedTuple of Rasters holding <a class="highlight-link">.tif</a> files, or all Rasters in memory. Users do not need to worry about the specifics of spatial file types.
   - title: 🌍🔍 Effortless Spatial Lookups

diff --git a/docs/src/array_operations.md → docs/src/manual/array_operations.md b/docs/src/array_operations.md → docs/src/manual/array_operations.md
diff --git a/docs/src/data_sources.md → docs/src/manual/data_sources.md b/docs/src/data_sources.md → docs/src/manual/data_sources.md
diff --git a/docs/src/methods.md → docs/src/manual/methods.md b/docs/src/methods.md → docs/src/manual/methods.md
diff --git a/docs/src/plot_makie.md → docs/src/manual/plot_makie.md b/docs/src/plot_makie.md → docs/src/manual/plot_makie.md
diff --git a/docs/src/plotting.md → docs/src/manual/plotting.md b/docs/src/plotting.md → docs/src/manual/plotting.md
diff --git a/docs/src/gbif_wflow.md → docs/src/tutorials/gbif_wflow.md b/docs/src/gbif_wflow.md → docs/src/tutorials/gbif_wflow.md