restructure & add intro content

Author: snopoke

docs/assets/visualization.png

@@ -1,234 +1,31 @@
----
-title: Quick Start
----
-# Get the Badger working!
+# Welcome to Task Badger Documentation
 
-Let's discover **Task Badger in less than 5 minutes**.
+Task Badger is a specialized monitoring system designed to provide deep visibility into your background jobs and asynchronous tasks. While it doesn't handle task execution itself, Task Badger seamlessly integrates with popular task processing systems like Celery to give developers comprehensive insights into their task operations. With Task Badger, you can track task progress, analyze performance patterns, and debug issues across your distributed task processing infrastructure. Whether you're managing a small set of periodic jobs or orchestrating complex distributed workflows, Task Badger offers the monitoring and observability tools you need to ensure your tasks are running smoothly.
 
-## Setup
+![Task Badger](assets/visualization.png)
 
-In order to use the API you will need the following details:
+## Key Features
 
-* Organization slug
-    * You can get this by going to 'My Organization'  
-* Project slug
-    * Go to the 'Projects' page. The slug for each project is listed. 
-* API Key
-    * Create one on your Profile page
+- **Task States**: Track the status of tasks with various states such as `pending`, `in_progress`, `completed`, `error`, and more.
+- **Actions and Triggers**: Automate actions based on task events using flexible trigger definitions.
+- **Integrations**: Connect with various services like email, webhooks, and more to extend the functionality of Task Badger
+- **Monitoring and Alerts**: Stay informed with real-time monitoring and customizable alerts for task events.
 
+## Getting Started
 
-## Montior Celery Tasks
+To get started with Task Badger, check out the following sections:
 
-When using the [Celery integration](python-celery.md) you can use the `CelerySystemIntegration` class to automatically record tasks.
+- [Quick Start Guide](quick.md): Learn how to set up and start using Task Badger.
+- [Task States](data_model.md): Understand the different states a task can be in and how they are managed.
+- [Task Actions](data_model.md#task-actions): Discover how to configure actions and triggers to automate your workflows.
+- [API Reference](api.md): Explore the API documentation to integrate Task Badger with your applications.
+- [Python SDK](python.md): Get started with the Python SDK to interact with Task Badger programmatically.
 
-```python
-from celery import Celery
-import taskbadger
-from taskbadger.systems.celery import CelerySystemIntegration
+## Community and Support
 
-app = Celery('hello', broker='amqp://guest@localhost//')
+Join our community to get help, share ideas, and stay updated with the latest news:
 
-taskbadger.init(
-    organization_slug="my-org",
-    project_slug="my-project",
-    token="***",
-    tags={"environment": "production"},
-    systems=[CelerySystemIntegration(record_task_args=True)]
-)
+- [GitHub](https://github.com/Task Badger): Report issues, contribute to the project, and browse the source code.
+- [Twitter](https://twitter.com/@task_badger): Follow us for updates and announcements.
 
-@app.task
-def hello(who):
-    return f'hello {who}'
-```
-
-This is all the configuration that is needed to do basic task tracking with Celery.
-
-## Monitor a task from the command line
-
-The Task Badger CLI allows you to run commands from the shell and have them monitored
-by Task Badger. The task status will get updated once the command completes.
-
-### Install and configure the CLI
-
-```bash
-$ python3 -m pip install taskbadger
-
-$ taskbadger configure
-
-Organization slug: my-org 
-Project slug: project-x 
-API Key: XYZ.ABC
-
-Config written to ~/.config/taskbadger/confi
-```
-
-### Use the CLI to run and monitor the command
-
-```shell
-$ taskbadger run "demo task" \
-  --action "error email to:[email protected]" \
-  --tag "environment=staging" \
-  -- path/to/script.sh
-
-Task created: https://taskbadger.net/public/tasks/xyz/
-```
-
-If the command completes with a non-zero exit code the task status will be set to `error`
-and an email will be sent to `[email protected]`.
-
-See more about the [CLI](cli.md).
-
-## Use the API directly
-
-=== "Python"
-
-    Install the `taskbadger` Python library:
-
-    ```shell
-    $ python3 -m pip install taskbadger
-    ```
-
-    Configure the API client:
-
-    ```python
-    import taskbadger
-
-    taskbadger.init(
-        organization_slug="my-org",
-        project_slug="my-project",
-        token="***",
-        tags={"environment": "production"},
-    )
-    ```
-
-=== "Shell"
-
-    Export the configuration parameters:
-
-    ```shell
-    export ORG="my-org"
-    export PROJECT="my-project"
-    export API_KEY="***"
-    ```
-
-### Creating a task
-
-Creating a task is very simple. Make a POST request to the API with the task
-data.
-
-=== "Python"
-
-    ```python
-    > task = Task.create("task name", stale_timeout=10, tags={"environment": "staging"})
-    > task.id
-    "128aoa98e0fiq238"
-    ```
-
-=== "Shell"
-
-    ```shell
-    $ curl -X POST "https://taskbadger.net/api/${ORG}/${PROJECT}/tasks/" \
-      -H "Authorization: Bearer ${API_KEY}" \
-      -H "Content-Type: application/json" \
-      -d '{"name": "demo task", "stale_timeout": 10, "tags": {"environment": "staging"}}'
-    ```
-
-    The response will include the task ID which is needed for updating the task.
-    
-    ```json title="Response"
-    {
-      "id": "{task_id}",
-      "organization": "my-org",
-      "project": "my-project",
-      "name": "demo task",
-      "status": "pending",
-      "value": null,
-      "value_max": null,
-      "value_percent": null,
-      "data": null,
-      "max_runtime": null,
-      "stale_timeout": 10,
-      "start_time": null,
-      "end_time": null,
-      "created": "2022-09-22T06:53:40.683555Z",
-      "updated": "2022-09-22T06:53:40.683555Z"
-      "url": "https://taskbadger.net/a/{example_org/tasks/{task_id}/",
-      "public_url": "https://taskbadger.net/public/tasks/{task_id}/",
-      "tags": {"environment": "staging"}
-    }
-    ```
-
-The task will now be listed in the task list: `https://taskbadger.net/a/${ORG}/tasks/`.
-
-### Update task progress
-
-Here we update the task `status` and `value`. By default, a task's value can range from
-0 to 100.
-
-=== "Python"
-
-    ```python
-    from taskbadger import StatusEnum
-    task.update(status=StatusEnum.PROCESSING, value=5)
-    ```
-
-=== "Shell"
-
-    ```shell
-    $ curl -X PATCH "https://taskbadger.net/api/${ORG}/${PROJECT}/tasks/${TASK_ID}/" \
-      -H "Authorization: Bearer ${API_KEY}" \
-      -H "Content-Type: application/json" \
-      -d '{"status": "processing", "value": 5}'
-    ```
-
-### Add an action to the task
-
-Here we update create a new action for the task so that we get notified when the task completes.
-
-=== "Python"
-
-    ```python
-    from taskbadger import Action, EmailIntegration
-    task.add_actions([
-        Action(
-            "*/10%,success,error",
-            integration=EmailIntegration(to="[email protected]")
-        )
-    ])
-    ```
-
-=== "Shell"
-    
-    ```shell
-    $ curl -X PATCH "https://taskbadger.net/api/${ORG}/${PROJECT}/tasks/${TASK_ID}/" \
-      -H "Authorization: Bearer ${API_KEY}" \
-      -H "Content-Type: application/json" \
-      -d '{"actions":[{"integration":"email","trigger":"success,error","config":{"to":"[email protected]"}}]}'
-    ```
-
-Read more about [actions](data_model.md#task-actions).
-
-### Mark the task complete
-
-When the task is complete update the status to either `success` or `error`.
-The value may also be updated to 100.
-
-=== "Python"
-  
-    ```python
-    task.update(status=StatusEnum.SUCCESS, value=100)
-    ```
-
-=== "Shell"
-
-    ```shell
-    $ curl -X PATCH "https://taskbadger.net/api/${ORG}/${PROJECT}/tasks/${TASK_ID}/" \
-      -H "Authorization: Bearer ${API_KEY}" \
-      -H "Content-Type: application/json" \
-      -d '{"status": "success", "value": 100}'
-    ```
-Also check your email to see if you got the notification.
-
-## A real example
-
-Take a look at how to apply this to a real [example](web_example.md).
+We hope you find Task Badger useful and look forward to your feedback!# Welcome to Task Badger Documentation