Move docs to top-level directory

This makes the docs a top-level directory in the hierarchy rather than hiding it in a subfolder of the client. It's preferable this way since the docs also contain some information regarding the backend, and we are not (currently) planning on making a separate backend docs folder.
aai-institute · Oct 1, 2024 · 9051391 · 9051391
1 parent 1a1f92e
commit 9051391
Show file tree

Hide file tree

Showing 19 changed files with 5 additions and 5 deletions.
diff --git a/client/docs/CONTRIBUTING.md b/client/docs/CONTRIBUTING.md
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -0,0 +1 @@
+../CONTRIBUTING.md
diff --git a/client/docs/_images/aai-favicon.png → docs/_images/aai-favicon.png b/client/docs/_images/aai-favicon.png → docs/_images/aai-favicon.png
diff --git a/client/docs/_images/aai-logo-cropped.png → docs/_images/aai-logo-cropped.png b/client/docs/_images/aai-logo-cropped.png → docs/_images/aai-logo-cropped.png
diff --git a/client/docs/_images/favicon.png → docs/_images/favicon.png b/client/docs/_images/favicon.png → docs/_images/favicon.png
diff --git a/client/docs/_images/logo.png → docs/_images/logo.png b/client/docs/_images/logo.png → docs/_images/logo.png
diff --git a/client/docs/_scripts/gen_api_ref_pages.py → docs/_scripts/gen_api_ref_pages.py b/client/docs/_scripts/gen_api_ref_pages.py → docs/_scripts/gen_api_ref_pages.py
@@ -14,9 +14,9 @@
 
 nav = mkdocs_gen_files.Nav()
 
-for path in sorted(Path("src").rglob("*.py")):
-    module_path = path.relative_to("src").with_suffix("")
-    doc_path = path.relative_to("src").with_suffix(".md")
+for path in sorted(Path("client/src").rglob("*.py")):
+    module_path = path.relative_to("client/src").with_suffix("")
+    doc_path = path.relative_to("client/src").with_suffix(".md")
     full_doc_path = Path("reference", doc_path)
 
     parts = list(module_path.parts)

diff --git a/client/docs/_styles/extra.css → docs/_styles/extra.css b/client/docs/_styles/extra.css → docs/_styles/extra.css
diff --git a/client/docs/_styles/theme.css → docs/_styles/theme.css b/client/docs/_styles/theme.css → docs/_styles/theme.css
diff --git a/client/docs/_theme_overrides/main.html → docs/_theme_overrides/main.html b/client/docs/_theme_overrides/main.html → docs/_theme_overrides/main.html
diff --git a/...ocs/_theme_overrides/partials/header.html → docs/_theme_overrides/partials/header.html b/...ocs/_theme_overrides/partials/header.html → docs/_theme_overrides/partials/header.html
diff --git a/client/docs/cli.md → docs/cli.md b/client/docs/cli.md → docs/cli.md
diff --git a/client/docs/concepts/_index.md → docs/concepts/_index.md b/client/docs/concepts/_index.md → docs/concepts/_index.md
diff --git a/client/docs/concepts/architecture.md → docs/concepts/architecture.md b/client/docs/concepts/architecture.md → docs/concepts/architecture.md
diff --git a/client/docs/concepts/identifiers.md → docs/concepts/identifiers.md b/client/docs/concepts/identifiers.md → docs/concepts/identifiers.md
diff --git a/client/docs/concepts/lifecycle.md → docs/concepts/lifecycle.md b/client/docs/concepts/lifecycle.md → docs/concepts/lifecycle.md
diff --git a/client/docs/index.md → docs/index.md b/client/docs/index.md → docs/index.md
diff --git a/client/docs/quickstart.md → docs/quickstart.md b/client/docs/quickstart.md → docs/quickstart.md
diff --git a/client/mkdocs.yml → mkdocs.yml b/client/mkdocs.yml → mkdocs.yml
@@ -22,7 +22,7 @@ nav:
 
 # Rebuild docs in `mkdocs serve` for changes in source code
 watch:
-    - src/
+    - client/src/
 
 plugins:
     - callouts