Updates to documentation ordering

GeoRegionsEcosystem · Oct 2, 2024 · df7d963 · df7d963
1 parent 88ca5bb
commit df7d963
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 7 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,7 +1,7 @@
 using Documenter
 using DocumenterVitepress
 using GeoRegions
-using CairoMakie
+import CairoMakie
 
 CairoMakie.activate!(type = "svg")
 

diff --git a/docs/src/api/project.md b/docs/src/api/project.md
@@ -8,7 +8,7 @@ deleteGeoRegions
 
 ## Handling custom lists of GeoRegions.jl
 
-```
+```@docs
 tableGeoRegions(
     fname :: AbstractString
 )

diff --git a/docs/src/assets/favicon.ico b/docs/src/assets/favicon.ico
diff --git a/docs/src/basics/index.md b/docs/src/basics/index.md
@@ -1,3 +1,4 @@
+```@raw html
 <script setup lang="ts">
 import Gallery from "../components/Gallery.vue";
 
@@ -51,3 +52,4 @@ const predefined = [
 ## Predefined GeoRegions
 
 <Gallery :images="predefined" />
+```
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -15,10 +15,10 @@ hero:
       link: /georegions
     - theme: alt
       text: Basics
-      link: /basics/read/overview
+      link: /basics
     - theme: alt
       text: Tutorials
-      link: /tutorials/using/isin
+      link: /tutorials
     - theme: alt
       text: View on Github
       link: https://github.com/GeoRegionsEcosystem/GeoRegions.jl
@@ -31,8 +31,8 @@ features:
     link: /basics/shape
   - icon: <img width="64" height="64" src="https://img.icons8.com/arcade/64/markdown.png" alt="markdown"/>
     title: Predefined GeoRegions
-    details: Many predefined Geographic Regions bundled, from the IPCC AR6 report
-    link: /basics/read/predefined
+    details: Many predefined Geographic Regions bundled from different datasets
+    link: /basics/predefined/datasets
   - icon: <img width="64" height="64" src="https://img.icons8.com/arcade/64/markdown.png" alt="markdown"/>
     title: Customizable
     details: Define your own custom Geographic Regions and save them for later

diff --git a/docs/src/tutorials/index.md b/docs/src/tutorials/index.md
@@ -1,3 +1,4 @@
+```@raw html
 <script setup lang="ts">
 import Gallery from "../components/Gallery.vue";
 
@@ -53,3 +54,4 @@ const projects = [
 ## Predefined GeoRegions
 
 <Gallery :images="projects" />
+```
diff --git a/docs/src/tutorials/using/ison.md b/docs/src/tutorials/using/ison.md
@@ -8,7 +8,7 @@ Sometimes, we don't just want information on whether a point is _inside_ a `GeoR
 ```@example ison
 using GeoRegions
 using DelimitedFiles
-using CairoMakie
+import CairoMakie: Figure, Axis, lines!, scatter!, resize_to_layout!
 
 download("https://raw.githubusercontent.com/natgeo-wong/GeoPlottingData/main/coastline_resl.txt","coast.cst")
 coast = readdlm("coast.cst",comments=true)