Start docs

docs/about.md

@@ -0,0 +1,19 @@
+# About Napari-Easy-Augment-Batch-dl
+
+Napari-Easy-Augment-Batch-dl is a user-friendly plugin for Napari designed to simplify batch image augmentation. It provides an intuitive graphical interface that allows users to load images, apply augmentations, and process large datasets efficiently without requiring programming knowledge.
+
+## 🔍 Features
+- Easy-to-use GUI for batch image augmentation.
+- Supports various augmentation techniques such as rotation, flipping, noise addition, and brightness adjustments.
+- Real-time preview of augmentations before applying changes.
+- Streamlined workflow with three simple steps: Load & Label, Configure Augmentations, and Train & Predict.
+- Ideal for researchers, data scientists, and image analysis professionals.
+
+## 🎯 Purpose
+The primary goal of Napari-Easy-Augment-Batch-dl is to bridge the gap between advanced image augmentation techniques and users who need a simple, no-code solution. Whether you are working with machine learning datasets, medical imaging, or scientific research, this tool helps you prepare high-quality augmented images efficiently.
+
+## 🛠️ Development & Contributions
+Napari-Easy-Augment-Batch-dl is an open-source project, and contributions are welcome! If you have feature requests, bug reports, or would like to contribute, visit our [GitHub repository](https://github.com/YOUR_REPO).
+
+## 📞 Support
+For questions, issues, or feedback, please check our [FAQ](faq.md) or open a discussion on our GitHub page.

docs/augment.md

@@ -0,0 +1,15 @@
+# Configure Augmentations  
+
+Set up your augmentation settings before processing your images.  
+
+## 🎛️ Augmentation Panel  
+![Augmentation Panel](images/augment_panel.png)  
+
+### Steps:  
+1️⃣ Select the augmentation types (rotation, flipping, noise, etc.).  
+2️⃣ Adjust the parameters as needed.  
+3️⃣ Preview the augmentations before applying.  
+
+---
+
+🔄 **Next:** [Run & Export](run_and_export.md)  

docs/faq.md

@@ -0,0 +1,16 @@
+# Frequently Asked Questions (FAQ)
+
+## ❓ General Questions
+
+### What is Napari-Easy-Augment-Batch-dl?
+Napari-Easy-Augment-Batch-dl is a plugin for Napari that allows users to batch augment images easily. It provides an intuitive GUI to load images, apply augmentations, and process them efficiently.
+
+### Who is this tool for?
+This tool is designed for users who need to augment images in bulk, such as researchers, machine learning practitioners, and image analysts. No programming knowledge is required.
+
+## 🔄 Usage Questions
+
+### How do I install the plugin?
+You can install it using pip:
+```sh
+pip install napari-easy-augment-batch-dl

docs/index.md

@@ -0,0 +1,23 @@
+# Napari Easy Augment Batch DL
+
+🚀 **Napari-Easy-Augment-Batch-dl** is a user-friendly plugin for batch augmenting images in **Napari**.  
+It allows you to quickly load, label, and process images with just a few clicks.
+
+## 🔥 Features  
+✅ **Batch Processing** – Apply augmentations to multiple images at once.  
+✅ **Easy Labeling** – Quickly assign labels using an intuitive GUI.  
+✅ **Seamless Integration** – Works inside **Napari** for an interactive experience.  
+✅ **Customizable** – Adjust augmentation settings to fit your workflow.  
+
+## 📖 How It Works  
+1️⃣ **Load and Label** – Import images and apply labels.  
+2️⃣ **Configure Augmentations** – Choose transformations like rotation, flipping, or noise.  
+3️⃣ **Run & Export** – Process images and save results.  
+
+## 📸 Screenshots  
+🖼️ Add screenshots here to show the workflow.  
+
+## 🚀 Get Started  
+1. Install the plugin:  
+   ```sh
+   pip install napari-easy-augment-batch-dl

docs/load_and_label.md

@@ -0,0 +1,15 @@
+# Load and Label
+
+The first step is to load your images and assign labels.
+
+## 📌 Load Panel  
+![Load Panel](images/load_panel.png)  
+
+### Steps:  
+1️⃣ Click the **Load** button.  
+2️⃣ Select your image files.  
+3️⃣ Assign labels as needed.  
+
+---
+
+🔄 **Next:** [Configure Augmentations](configure_augmentations.md)  

docs/train_and_predict.md

@@ -0,0 +1,15 @@
+# Train and Predict  
+
+Train a model using your labeled data and make predictions on new images.  
+
+## 🏋️ Training & Prediction Panel  
+![Training Panel](images/train_panel.png)  
+
+### Steps:  
+1️⃣ Choose a model or configure training parameters.  
+2️⃣ Train using labeled images.  
+3️⃣ Use the trained model to predict labels on new images.  
+
+---
+
+🔄 **Next:** [Run & Export](run_and_export.md)  

mkdocs.yml

@@ -0,0 +1,28 @@
+site_name: Napari Easy Augment Batch DL
+theme:
+  name: material
+  palette:
+    scheme: default
+    primary: blue
+  features:
+    - navigation.instant
+    - search.highlight
+    - content.code.annotate
+
+nav:
+  - Home: index.md
+  - Load and Label: load_and_label.md
+  - Augment: augment.md
+  - Train and Predict: train_and_predict.md
+  - FAQ: faq.md
+  - About: about.md
+
+markdown_extensions:
+  - admonition  # Adds note/warning boxes
+  - pymdownx.superfences  # Improves code blocks
+  - pymdownx.emoji  # Supports emoji like :smile:
+
+extra:
+  generator: false  # Removes "Built with MkDocs" footer
+
+repo_url: https://github.com/myrepo  # Change to your repo URL