doc updates

README.md

@@ -4,7 +4,37 @@
 
 This library is currently under development and is not intended for general usage yet. Functionality is experimental until release 0.1.0.
 
-## Installation
+# Install Dev Version
+
+```bash
+pip install git+https://github.com/business-science/pytimetk.git
+```
+
+# Quickstart:
+
+This is a simple code to test the function `summarize_by_time`:
+
+```python
+import timetk
+import pandas as pd
+
+df = timetk.datasets.load_dataset('bike_sales_sample')
+df['order_date'] = pd.to_datetime(df['order_date'])
+
+df \
+    .summarize_by_time(
+        date_column='order_date', 
+        value_column= 'total_price',
+        groups = "category_2",
+        freq = "M",
+        kind = 'timestamp',
+        agg_func = ['mean', 'sum']
+    )
+```
+
+
+
+## Developers (Contributors): Installation
 
 To install `timetk` using [Poetry](https://python-poetry.org/), follow these steps:
 
@@ -37,26 +67,4 @@ or you can create a virtualenv with poetry and install the dependencies
 ```bash
 poetry shell
 poetry install
-```
-
-# Usage
-
-This is a simple code to test the function `summarize_by_time`:
-
-```python
-import timetk
-import pandas as pd
-
-df = timetk.datasets.load_dataset('bike_sales_sample')
-df['order_date'] = pd.to_datetime(df['order_date'])
-
-df \
-    .summarize_by_time(
-        date_column='order_date', 
-        value_column= 'total_price',
-        groups = "category_2",
-        freq = "M",
-        kind = 'timestamp',
-        agg_func = ['mean', 'sum']
-    )
-```
+```

docs/_freeze/getting-started/01_installation/execute-results/html.json

@@ -1,9 +1,9 @@
 {
-  "hash": "dd18664a45403263527305f37122f2d6",
+  "hash": "1d4b00d8fea30f9bbb9a80d51866b6cd",
   "result": {
-    "markdown": "---\ntitle: Install\n---\n\n::: {.callout-warning collapse=\"false\"}\n## Under Development\n\nThis library is currently under development and is not intended for general usage yet. Functionality is experimental until release 0.1.0. \n:::\n\n\n## Installation\n\nTo install `timetk` using [Poetry](https://python-poetry.org/), follow these steps:\n\n### 1. Prerequisites\n\nMake sure you have Python 3.9 or later installed on your system.\n\n### 2. Install Poetry\n\nTo install Poetry, you can use the [official installer](https://python-poetry.org/docs/#installing-with-the-official-installer)  provided by Poetry. Do not use pip.\n\n### 3. Clone the Repository\n\nClone the `timetk` repository from GitHub:\n\n```\ngit clone https://github.com/business-science/pytimetk\n```\n\n### 4. Install Dependencies\n\nUse Poetry to install the package and its dependencies:\n\n```\npoetry install\n```\n\nor you can create a virtualenv with poetry and install the dependencies\n\n```\npoetry shell\npoetry install\n```\n\n",
+    "markdown": "---\ntitle: Install\ntoc: true\ntoc-depth: 3\nnumber-sections: true\nnumber-depth: 2\n---\n\n::: {.callout-warning collapse=\"false\"}\n## Under Development\n\nThis library is currently under development and is not intended for general usage yet. Functionality is experimental until release 0.1.0. \n:::\n\n## Quick Install\n\nLet's get you up and running with `timetk` fast. You can install from GitHub with this code. \n\n```bash\npip install git+https://github.com/business-science/pytimetk.git\n```\n\n",
     "supporting": [
-      "01_installation_files\\figure-html"
+      "01_installation_files"
     ],
     "filters": [],
     "includes": {}

docs/_freeze/guides/01_visualization/execute-results/html.json

@@ -1,9 +1,9 @@
 {
-  "hash": "92850dbb8bfde6b36c5868a81d9acab3",
+  "hash": "18cc71a8b77510ec0143e6ffa2a3e1b5",
   "result": {
     "markdown": "---\ntitle: Data Visualization\ntoc: true\ntoc-depth: 3\nnumber-sections: true\nnumber-depth: 2\n---\n\nComing soon...\n\n",
     "supporting": [
-      "01_visualization_files\\figure-html"
+      "01_visualization_files/figure-html"
     ],
     "filters": [],
     "includes": {}

docs/_quarto.yml

@@ -59,13 +59,26 @@ website:
         contents: getting-started/*
       - section: "🗺️ Guides:"
         contents: guides/*
+      - section: "📘 Applied Tutorials:"
+        contents: tutorials/*
+      - text: "---"
       - text: 📄 API Reference
         file: reference/index.qmd
       - text: "---"
+      - text: ⭐ Timetk on Github
+        file: https://github.com/business-science/pytimetk
+        external: true
+      - text: "---"
+      - text: 🍻 Contributing
+        file: contributing.qmd
+      - text: "---"
       - section: "More References:"
       - text: Business Science
         file: https://www.business-science.io/index.html
         external: true
+      - text: Quant Science
+        file: https://www.quantscience.io/
+        external: true
       - text: Timetk (R Version)
         file: https://business-science.github.io/timetk/
         external: true

docs/_sidebar.yml

@@ -19,19 +19,24 @@ website:
       section: "\U0001F3D7\uFE0F Adding Features to Time Series DataFrames (Augmenting)"
     - contents:
       - reference/ts_features.qmd
+      - reference/ts_summary.qmd
       section: TS Features
     - contents:
       - reference/make_future_timeseries.qmd
       - reference/make_weekday_sequence.qmd
       - reference/make_weekend_sequence.qmd
-      section: "\U0001F43C Time Series for Pandas Series"
-    - contents:
+      - reference/get_date_summary.qmd
+      - reference/get_frequency_summary.qmd
+      - reference/get_diff_summary.qmd
       - reference/get_pandas_frequency.qmd
       - reference/get_timeseries_signature.qmd
       - reference/get_holiday_signature.qmd
+      section: "\U0001F43C Time Series for Pandas Series"
+    - contents:
       - reference/floor_date.qmd
       - reference/is_holiday.qmd
       - reference/week_of_month.qmd
+      - reference/timeseries_unit_frequency_table.qmd
       section: "\U0001F6E0\uFE0F Utilities"
     - contents:
       - reference/get_available_datasets.qmd