More updates to documentation

GeoRegionsEcosystem · Sep 24, 2024 · 97b8c9d · 97b8c9d
1 parent bdf05aa
commit 97b8c9d
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 2 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -20,7 +20,7 @@ makedocs(;
     pages=[
         "Home"                      => "index.md",
         "What is a GeoRegion?"      => "georegions.md",
-        "Basic Functionality" => [
+        "Basics" => [
             "Retrieving GeoRegions" => [
                 "Overview (START HERE)"  => "basics/read/overview.md",
                 "Predefined GeoRegions"  => "basics/read/predefined.md",
@@ -33,7 +33,7 @@ makedocs(;
                 "Is it in a GeoRegion?" => "basics/properties/isin.md",
             ]
         ],
-        "GeoRegions.jl Tutorials"   => [
+        "Tutorials"   => [
             "Project Setup (START HERE)" => "tutorials/projects.md",
             "Custom GeoRegion Files"     => "tutorials/files.md",
         ],

diff --git a/docs/src/api/addreadremove.md b/docs/src/api/addreadremove.md
@@ -0,0 +1,19 @@
+# API for Adding, Reading and Removing GeoRegions
+
+```@docs
+GeoRegion(
+        geoID :: AbstractString;
+        path  :: AbstractString = homedir()
+    ) -> geo :: GeoRegion
+```
+
+```@docs
+add
+rm
+```
+
+You can also remove a GeoRegion associated with an `ID`.
+
+```@docs
+rmID
+```
diff --git a/docs/src/api/project.md b/docs/src/api/project.md
@@ -0,0 +1,8 @@
+# API for Project-Handling in GeoRegions.jl
+
+
+```@docs
+setupGeoRegions
+tableGeoRegions
+deleteGeoRegions
+```