Update README and documentation structure

Author: jsj

.github/workflows/docs.yml

@@ -14,10 +14,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+
       - uses: actions/setup-python@v4
         with:
           python-version: 3.x
+
       - run: |
           python -m pip install --upgrade pip
           pip install -e .[docs]
+          mv README.md docs/index.md
+          mv assets/images docs/assets/images
+
       - run: mkdocs gh-deploy --force

README.md

@@ -2,7 +2,12 @@
 A collection of Spark-free Python utilities for working with Microsoft Fabric in Python Notebooks.
 Mainly focused on Data Engineering tasks utilising [Polars](https://github.com/pola-rs/polars) and [delta-rs](https://github.com/delta-io/delta-rs).
 
-![How to select Python Notebook](docs/images/select-python-notebooks.png)
+![How to select Python Notebook](assets/images/select-python-notebooks.png)
+
+## Installation
+```bash
+pip install msfabricutils
+```
 
 ## Features
 
@@ -14,6 +19,19 @@ Mainly focused on Data Engineering tasks utilising [Polars](https://github.com/p
 - Common transformations (add audit columns, reorder columns, deduplicate etc.)
 - Load delta tables with one of the provided load methods (upsert, overwrite, append etc.)
 
+
+
+### Fabric API
+- Create, update, delete workspaces, lakehouses, notebooks using the Fabric REST API.
+
+### Command Line Interface
+- Create, update, delete workspaces, lakehouses, notebooks using the built-in CLI.
+
+To get started, run:
+```bash
+msfu --help
+```
+
 ### Fabric DuckDB Connection
 Seamless integration between DuckDB and Microsoft Fabric Lakehouses for data exploration and analysis.
 
@@ -23,20 +41,17 @@ Seamless integration between DuckDB and Microsoft Fabric Lakehouses for data exp
 - Support for Delta Lake tables
 - Flexible table name referencing (1-part to 4-part names)
 
-## Installation
-```bash
-pip install msfabricutils
-```
 
 ## Documentation
 For quick start and detailed documentation, examples, and API reference, visit our [GitHub Pages documentation](https://mrjsj.github.io/msfabricutils/).
 
-# Contributing
+## Contributing
 Contributions are welcome! Here are some ways you can contribute:
+
 - Report bugs and feature requests through GitHub issues
 - Submit pull requests for bug fixes or new features
 - Improve documentation
 - Share ideas for new utilities
 
-# License
+## License
 This project is licensed under the MIT License - see the LICENSE file for details.

docs/images/select-python-notebooks.png assets/images/select-python-notebooks.pngdocs/images/select-python-notebooks.png renamed to assets/images/select-python-notebooks.png

@@ -1,33 +1 @@
-# MSFabricUtils
-
-A collection of **Spark-free** and **local-first** Python utilities for working with Microsoft Fabric Lakehouses locally or in the Fabric Python Notebook experience.
-
-## Features
-
-- **ETL Utilities** - Extract, Transform, Load data from and to Microsoft Fabric Lakehouses. While the utilities can be configured to fit different needs, its defaults are highly opinionated for what we believe are sensible defaults for many use cases
-- **Fabric API** - Access Fabric APIs from Python, such as workspaces and lakehouses
-- **Local development first** - Aim to provide a local development for Microsoft Fabric solutions
-- **DuckDB Connection** 
-    - Seamless integration between DuckDB and Microsoft Fabric Lakehouses
-    - Cross-lakehouse and cross-workspace querying
-    - Delta Lake writing features
-
-## Core dependencies
-
-MSFabricUtils is built on top of modern, high-performance Python libraries:
-
-- **[delta-rs](https://delta-io.github.io/delta-rs)** - A native Rust implementation of Delta Lake, providing fast and reliable Delta Lake operations without the need for a Spark cluster
-- **[Polars](https://pola.rs)** - A lightning-fast DataFrame library written in Rust, offering superior performance for data manipulation tasks
-- **[DuckDB](https://duckdb.org)** - An embedded analytical database engine, enabling SQL queries with at blazing speed
-
-These dependencies were chosen specifically to:
-
-- Provide Spark-like functionality without the overhead of a Spark cluster
-- Enable high-performance data processing on a single machine
-- Support both local development and cloud deployment scenarios
-- Maintain compatibility with Delta Lake format used in Microsoft Fabric
-
-
-## Ideas for improvements
-Got an idea? Add an issue on [github](https://www.github.com/mrjsj/msfabricutils/issues)!
-
+# Placeholder

docs/index.md

@@ -1,6 +1,6 @@
 # Fabric API
 
-A collection of helper functions for working with the Fabric API. See the [API Reference](../core/fabric-api.md) for more details.
+A collection of helper functions for working with the Fabric API. See the [API Reference](../core/fabric-api/index.md) for more details.
 
 ## List workspaces