docs: update docs

lucas-nelson-uiuc · Dec 28, 2024 · 176cb73 · 176cb73
1 parent 9401b62
commit 176cb73
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 14 deletions.
diff --git a/docs/api/core/core.md b/docs/api/core/core.md
diff --git a/docs/api/core/filter.md b/docs/api/core/filter.md
@@ -0,0 +1 @@
+::: tidy_tools.core.filter
diff --git a/docs/api/core/selector.md b/docs/api/core/selector.md
@@ -0,0 +1 @@
+::: tidy_tools.core.selector
diff --git a/docs/user-guide/installation.md b/docs/user-guide/installation.md
@@ -8,14 +8,15 @@ pip install tidy-tools
 
 ## Importing
 
-To use the library, simply import it into your project:
+To use the package, import it into your project:
 
 ``` python
-# import top-level package
-import tidy_tools as tt
+# import top-level package (includes welcome message)
+import tidy_tools
 
 # import specific modules as needed
-from tidy_tools.core import selectors as cs
+from tidy_tools.core import selectors as cs, filter as ttf
 from tidy_tools.frame import TidyDataFrame
 from tidy_tools.models import TidyDataModel
+from tidy_tools.workflow import pipe, compose
 ```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -48,7 +48,8 @@ nav:
   - API Documentation:
     - api/api-reference.md
     - Core:
-      - api/core/core.md
+      - api/core/selector.md
+      - api/core/filter.md
     - DataFrame:
       - api/dataframe/context.md
       - api/dataframe/dataframe.md