add pages

cheshire-cat-ai · Jun 10, 2024 · 02d0946 · 02d0946
1 parent 37bd442
commit 02d0946
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 11 deletions.
diff --git a/gen_pages.py b/gen_pages.py
@@ -5,13 +5,6 @@
 import fnmatch
 import mkdocs_gen_files
 
-KEEP_PAGES = [
-    "cheshire_cat", "stray_cat", "agent", "flow",
-    "prompt", "rabbithole", "settings", "mad_hatter",
-    "plugin", "vector_memory", "vector_memory_collection",
-    "working_memory", "log", "rabbit_hole", "utils",  # "__init__"
-]
-
 nav = mkdocs_gen_files.Nav()
 
 core_code_dir = 'cheshire_cat_api'
@@ -26,7 +19,7 @@
 
     module_path = path.relative_to(core_code_dir).with_suffix("")
     doc_path = path.relative_to(core_code_dir).with_suffix(".md")
-    full_doc_path = Path("API_Reference", doc_path)
+    full_doc_path = Path("API_Documentation", doc_path)
 
     parts = tuple(module_path.parts)
 
@@ -48,7 +41,7 @@
 
     mkdocs_gen_files.set_edit_path(full_doc_path, path)
 
-with mkdocs_gen_files.open("API_Reference/SUMMARY.md", "w") as nav_file:  #
+with mkdocs_gen_files.open("API_Documentation/SUMMARY.md", "w") as nav_file:  #
     if os.path.exists(core_code_dir):
         nav_file.writelines(nav.build_literate_nav())  #
     else:

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -28,8 +28,10 @@ plugins:
 #  - mkdocs/hooks/drawio_file.py
 
 nav:
-  - Hello, dear: index.md
-  - API: API_Reference/
+  - Getting started:
+      - Installation: getting_started/installation.md
+      - Usage: getting_started/examples.md
+  - API Documentation: API_Documentation/
 
 theme:
   name: material

diff --git a/mkdocs/getting_started/examples.md b/mkdocs/getting_started/examples.md
@@ -0,0 +1 @@
+# Coming soon...
diff --git a/mkdocs/getting_started/installation.md b/mkdocs/getting_started/installation.md
@@ -0,0 +1 @@
+# Coming soon...