docs: switch to material theme

MrPowers · Jan 27, 2024 · 3fe6557 · 3fe6557
1 parent cf06721
commit 3fe6557
Show file tree

Hide file tree

Showing 4 changed files with 278 additions and 130 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -1 +1,10 @@
-{!README.md!}
+# Quinn
+
+Quinn containts PySpark helper methods that will make you more productive.
+
+Quinn is also a great way to learn about PySpark best practices like how to organize and unit test your code.
+
+We have a solid group of maintainers, chat on contributor meetings reguarly, and eagerly accept contributions from other members.
+
+We want to help the world write beautiful PySpark and give them a wonderful developer experience.
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,7 +1,7 @@
 site_name: Quinn
 
 theme:
-  name: "readthedocs"
+  name: material
 
 plugins:
   - search
@@ -21,11 +21,11 @@ plugins:
   - mkdocs-jupyter
 
 nav:
-  - Quin: index.md
+  - Home: index.md
   - API Docs: reference/SUMMARY.md
   - Examples:
       - "notebooks/schema_as_code.ipynb"
 
 markdown_extensions:
     - markdown_include.include:
-        base_path: .
+        base_path: docs