docs: "user guide" section cleanup (#826)

* docs: "user guide" section cleanup Renamed the section from "How To Guides" to "User Guide". Changed the title of "User Guide" pages to be easier to visually scan. Essentially, this consists of shorter titles with the most important word at the beginning * updated docs --------- Co-authored-by: zilto <tjean@DESKTOP-V6JDCS2>
DAGWorks-Inc · Apr 17, 2024 · 431cc21 · 431cc21
1 parent 98ce413
commit 431cc21
Show file tree

Hide file tree

Showing 16 changed files with 31 additions and 40 deletions.
diff --git a/docs/how-tos/cache-nodes.rst b/docs/how-tos/cache-nodes.rst
@@ -1,5 +1,5 @@
 ======================
-Cache Node Computation
+Caching results
 ======================
 
 Sometimes it is convenient to cache intermediate nodes. This is especially useful during development.

diff --git a/docs/how-tos/cli-reference.md b/docs/how-tos/cli-reference.md
@@ -1,4 +1,4 @@
-# Hamilton CLI
+# Command line interface
 
 This page covers the Hamilton CLI. It is built directly from the CLI, but note that the command `hamilton --help` always provide the most accurate documentation.
 

diff --git a/docs/how-tos/index.rst b/docs/how-tos/index.rst
@@ -1,5 +1,5 @@
 ==============
-How To Guides
+User Guide
 ==============
 
 This portion of the documentation goes over the set of common examples for Hamilton usage, so you can apply
@@ -8,18 +8,16 @@ directory. If there's an example you want but don't see, reach out or open an is
 
 
 .. toctree::
-   load-data
-   use-without-pandas
    use-in-jupyter-notebook
-   run-data-quality-checks
-   scale-up
-   use-for-training-models
-   use-with-dbt
-   use-online
+   load-data
    use-for-feature-engineering
+   ml-training
+   llm-workflows
+   run-data-quality-checks
    use-hamilton-for-lineage
-   use-hamilton-for-llm-workflows
+   cache-nodes
+   scale-up
+   microservice
+   wrapping-driver
    cli-reference
    pre-commit-hooks
-   cache-nodes
-   custom-driver
diff --git a/...how-tos/use-hamilton-for-llm-workflows.md → docs/how-tos/llm-workflows.md b/...how-tos/use-hamilton-for-llm-workflows.md → docs/how-tos/llm-workflows.md
@@ -1,4 +1,4 @@
-# How to use Hamilton for LLM Workflows
+# LLM workflows
 
 Hamilton is great for describing dataflows, and a lot of "actions" you want
 an "agent" to perform can be described as one, e.g. create an embedding

diff --git a/docs/how-tos/load-data.rst b/docs/how-tos/load-data.rst
@@ -1,5 +1,5 @@
 ==================
-Load External Data
+Loading data
 ==================
 
 While we've been injecting data in from the driver in previous examples, Hamilton functions are fully capable of loading their own data.

diff --git a/docs/how-tos/use-online.rst → docs/how-tos/microservice.rst b/docs/how-tos/use-online.rst → docs/how-tos/microservice.rst
@@ -1,5 +1,5 @@
 ==============================
-Run Hamilton in a Microservice
+Microservice
 ==============================
 
 While we've mainly been discussing running Hamilton in a batch environment, it can easily be used

diff --git a/docs/how-tos/use-for-training-models.rst → docs/how-tos/ml-training.rst b/docs/how-tos/use-for-training-models.rst → docs/how-tos/ml-training.rst
@@ -1,5 +1,5 @@
 ===============================
-Use Hamilton for Model Training
+Model training
 ===============================
 
 As Hamilton is a generic library for representing dataflows in pandas, it can be used for a wide array of tasks.

diff --git a/docs/how-tos/pre-commit-hooks.md b/docs/how-tos/pre-commit-hooks.md
@@ -1,4 +1,4 @@
-# Hamilton pre-commit
+# pre-commit hooks
 ## Use pre-commit hooks for safer Hamilton code changes
 
 This page gives an introduction to pre-commit hooks and how to use custom hooks to validate your Hamilton code.

diff --git a/docs/how-tos/run-data-quality-checks.rst b/docs/how-tos/run-data-quality-checks.rst
@@ -1,5 +1,5 @@
 =======================
-Run Data Quality Checks
+Data quality
 =======================
 
 Hamilton comes with data quality included out of the box.

diff --git a/docs/how-tos/scale-up.rst b/docs/how-tos/scale-up.rst
@@ -1,5 +1,5 @@
 =====================
-Run Hamilton at Scale
+Scaling computation
 =====================
 
 Hamilton enables a variety of tools for allowing you to scale your data processing by integrating with third-party libraries.

diff --git a/docs/how-tos/use-for-feature-engineering.rst b/docs/how-tos/use-for-feature-engineering.rst
@@ -1,5 +1,5 @@
 ==========================================
-Use Hamilton for Feature Engineering
+Feature engineering
 ==========================================
 
 Hamilton's roots are in time-series offline feature engineering. But it can be used for any type of feature engineering:

diff --git a/docs/how-tos/use-in-jupyter-notebook.md b/docs/how-tos/use-in-jupyter-notebook.md
@@ -1,4 +1,4 @@
-# Using Hamilton in a notebook
+# Jupyter notebooks
 
 There are two main ways to use Hamilton in a notebook.
 

diff --git a/docs/how-tos/use-without-pandas.rst b/docs/how-tos/use-without-pandas.rst
diff --git a/docs/how-tos/custom-driver.rst → docs/how-tos/wrapping-driver.rst b/docs/how-tos/custom-driver.rst → docs/how-tos/wrapping-driver.rst
@@ -1,5 +1,4 @@
-
-Should I define my own Driver?
+Wrapping the Driver
 ------------------------------
 
 The APIs that the Hamilton Driver is built on, are considered internal. So it is possible for you to define your own

diff --git a/docs/how-tos/use-with-dbt.rst → docs/integrations/dbt.rst b/docs/how-tos/use-with-dbt.rst → docs/integrations/dbt.rst
@@ -1,5 +1,5 @@
 =====================
-Use Hamilton with DBT
+dbt
 =====================
 
 If you're familiar with DBT, you likely noticed that it can fill a similar role to Hamilton. What DBT does for SQL

diff --git a/docs/integrations/index.rst b/docs/integrations/index.rst
@@ -9,11 +9,19 @@ This section showcases how Hamilton integrates with popular frameworks.
     fastapi
     ibis/index
     streamlit
+    dbt
     Airflow <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/airflow>
+    Amazon Web Services <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/aws>
+    Burr <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/LLM_Workflows/image_telephone>
+    Dagster <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/dagster>
     Dask <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/dask>
-    dbt <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/dbt>
     Feast <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/feast>
+    Metaflow <https://github.com/outerbounds/hamilton-metaflow>
     Pandera <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/data_quality/pandera>
+    Plotly <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/plotly>
+    Polars <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/polars>
     Prefect <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/prefect>
     Ray <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/ray>
+    Slack <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/slack>
     Spark <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/spark>
+    Vaex <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/vaex>