new docs scaffold

2024-11-21 21:58:47 +00:00 · 2024-01-31 18:18:26 +01:00 · 2024-01-31 18:18:26 +01:00 · ab63a01582
parent abe50076a4
commit ab63a01582
11 changed files with 12 additions and 33 deletions
--- a/docs/concepts/adapters.md
+++ b/docs/concepts/adapters.md
--- a/docs/concepts/index.md
+++ b/docs/concepts/index.md
@ -0,0 +1 @@
+# WIP
--- a/docs/contributing/index.md
+++ b/docs/contributing/index.md
@ -1 +0,0 @@
-WIP
--- a/docs/fluxion/index.md
+++ b/docs/fluxion/index.md
@ -1 +0,0 @@
-WIP
--- a/docs/guides/index.md
+++ b/docs/guides/index.md
@ -0,0 +1 @@
+# WIP
--- a/docs/models/index.md
+++ b/docs/models/index.md
@ -1,3 +0,0 @@
-# Foundational Models
-
-WIP
--- a/docs/models/latent_diffusion.md
+++ b/docs/models/latent_diffusion.md
@ -1,3 +0,0 @@
-# Latent Diffusion
-
-WIP
--- a/docs/models/segment_anything.md
+++ b/docs/models/segment_anything.md
@ -1,3 +0,0 @@
-# Segment Anything
-
-WIP
--- a/docs/training_utils/index.md
+++ b/docs/training_utils/index.md
@ -1,9 +0,0 @@
-# Training Utils
-
-Very minimalistic training utilities for PyTorch, its main purpose is to provide a simple way to abstract the training loop
-and its configuration. It is meant to be used with Refiners, but it can be used with any PyTorch model.
-
-## Quickstart
-
-WIP
-
--- a/docs/training_utils/trainer.md
+++ b/docs/training_utils/trainer.md
--- a/mkdocs.yml
+++ b/mkdocs.yml
@ -31,18 +31,15 @@ extra_css:
 nav:
  - Home: 
    - index.md
-  - Getting started: getting_started.md
-  - Models: 
-    - models/index.md
-    - models/latent_diffusion.md
-    - models/segment_anything.md
-  - Fluxion:
-    - fluxion/index.md
-    - fluxion/adapters.md
-  - Training utils: 
-    - training_utils/index.md
-  - Contributing:
-    - contributing/index.md
+  - Getting started:
+    - getting_started.md
+  - Guides:
+    - guides/index.md
+  - Key Concepts:
+    - concepts/index.md
+    - concepts/adapters.md
+  - API Reference:
+      - index.md
 extra:
  social:
    - icon: fontawesome/brands/discord