update documentation

Co-Authored-By: Brendan Lyons <[email protected]>
Co-Authored-By: jmcclena <[email protected]>

Author: 3 people

README.md

@@ -1,5 +1,3 @@
-[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/ProjectTorreyPines/FUSE.jl)
-
 # FUSE.jl
 
 FUSE (**FU**sion **S**ynthesis **E**ngine) is an open-source framework for integrated simulations of fusion devices.
@@ -19,6 +17,7 @@ Here are some key resources for getting started with FUSE:
 * 📜 **[Preprint publication](https://arxiv.org/abs/2409.05894)**
 * 🆘 **[Discord community](https://discord.gg/CbjpZH9SKM)**
 * 🗒️ **[Weekly devs meeting minutes](https://github.com/ProjectTorreyPines/FUSE.jl/discussions)**
+* 🤔 **[Ask DeepWiki](https://deepwiki.com/ProjectTorreyPines/FUSE.jl)**
 
 ## Objectives
 

docs/make.jl

@@ -193,15 +193,21 @@ makedocs(;
     repo=Remotes.GitHub("ProjectTorreyPines", "FUSE.jl"),
     warnonly=true,
     pages=[
-        "Main" => "index.md",
-        "Learn" => ["Tutorial" => "tutorial.md", "Examples" => "examples.md", "Publications" => "pubs.md"],
+        "Home" => "index.md",
+        "Install" => "install.md",
+        "Tutorial" => "tutorial.md",
+        "Examples" => "examples.md",
         "Use Cases" => "cases.md",
-        "Actors" => ["List of actors" => "actors.md", "act parameters" => "act.md"],
-        "Initialization" => ["Init routines" => "inits.md", "ini parameters" => "ini.md"],
-        "Data Structure" => "dd.md",
-        "Development" => ["deps.md", "develop.md"],
-        "Install" => ["Install FUSE" => "install.md", "on SAGA" => "install_saga.md", "on OMEGA" => "install_omega.md"],
-        "License" => ["License" => "license.md", "Notice" => "notice.md"]
+        "Publications" => "pubs.md",
+        "Actors" => "actors.md",
+        "Initialization" => "inits.md",
+        "`act` Parameters" => "act.md",
+        "`ini` Parameters" => "ini.md",
+        "`dd` Data Structure" => "dd.md",
+        "Ecosystem" => "deps.md",
+        "Development" => "develop.md",
+        "License" => "license.md",
+        "Notice" => "notice.md"
     ]
 )
 

docs/src/install.md

@@ -105,3 +105,10 @@ For installation start your Julia interpreter by typing `julia` at the terminal,
    ```
 
 1. Run `fusebot install_IJulia` to install the Kernel for the latest version of Julia in Jupyter-Lab
+
+## Install on specific platforms
+
+```@contents
+Pages = ["install_omega.md", "install_saga.md"]
+Depth = 2
+```

docs/src/install_omega.md

@@ -1,4 +1,4 @@
-# Public FUSE installation on GA's Omega
+# On OMEGA cluster
 
 ## FUSE module
 

docs/src/install_saga.md

@@ -1,3 +1,5 @@
+# On SAGA cluster
+
 ## Getting started on the SAGA cluster
 
 1. Get a SAGA account and ask to have a directory created for you under `/mnt/beegfs/users/$USER`