Improve format

Author: oeway

docs/bioengine-apps.md

@@ -1,8 +1,8 @@
-### BioEngine Apps Development
+# BioEngine Apps Development
 
 Developing BioEngine Apps involves creating both user interfaces (UI Apps) and computational backends (Compute Apps). These apps work together to provide a seamless experience for bioimage analysis and AI-powered tasks. This guide offers a comprehensive overview of how developers can build and contribute BioEngine Apps, leveraging modern web technologies, the BioEngine platform, and its associated tools.
 
-#### 1. Developing UI Apps with ImJoy
+## 1. Developing UI Apps with ImJoy
 
 **Overview:**
 UI Apps are web-based interfaces that allow users to interact with BioEngine. They are designed to be intuitive, responsive, and capable of handling various tasks such as image uploading, configuring analysis parameters, visualizing results, and managing workflows.
@@ -79,7 +79,7 @@ ImJoy is a flexible platform that supports multiple plugin types, allowing devel
 5. **Deploying and Sharing Your UI App:**
    - Deploy the UI App on ImJoy or other platforms and share it with users by providing a URL or hosting it on platforms like GitHub.
 
-#### 2. Developing Compute Apps
+## 2. Developing Compute Apps
 
 **Overview:**
 Compute Apps are the backend services that perform the heavy computations required by BioEngine applications. These apps can be developed to run either as Hypha services in independent containers or directly on workstations, typically equipped with GPUs.
@@ -170,6 +170,6 @@ If developers want to submit their Compute App to the BioEngine platform, they n
 **Running the Compute App Locally or on a Server:**
 After submission, developers can continue to run their Compute Apps locally or on a server using Ray and Hypha, ensuring they meet performance and scalability requirements before or after integration with the BioEngine platform.
 
-#### Conclusion
+## Conclusion
 
 By following this guide, developers can create and contribute BioEngine Apps that integrate intuitive user interfaces with powerful backend computations. The flexibility of the BioEngine platform, combined with tools like ImJoy and Hypha, provides developers with the means to build, deploy, and scale applications that meet the growing needs of the bioimage analysis community. Whether running on local hardware or as part of a larger cloud infrastructure, BioEngine Apps enable cutting-edge research and collaboration in life sciences.

docs/tutorial-bioengine-apps.md

@@ -1,8 +1,8 @@
-### Step-by-Step Tutorial: How to Create BioEngine Apps
+# Step-by-Step Tutorial: How to Create BioEngine Apps
 
 Welcome to the tutorial on creating BioEngine Apps! In this guide, we'll walk you through the process of developing and submitting both UI and Compute Apps for the BioEngine platform. Whether you're building a user interface or a computational backend, this tutorial will help you get started and contribute your app to the BioEngine ecosystem.
 
-#### Prerequisites
+## Prerequisites
 
 Before you begin, ensure you have the following prerequisites:
 
@@ -18,7 +18,7 @@ Before you begin, ensure you have the following prerequisites:
      pip install ray
      ```
 
-#### Step 1: Set Up Your Development Environment
+## Step 1: Set Up Your Development Environment
 
 1. **Clone the BioEngine Repository:**
    - Start by cloning the BioEngine GitHub repository to your local machine:
@@ -34,7 +34,7 @@ Before you begin, ensure you have the following prerequisites:
      cd my-bioengine-app
      ```
 
-#### Step 2: Develop the Compute App
+## Step 2: Develop the Compute App
 
 Compute Apps are the backend services that perform computations. In this example, we'll create a simple Compute App using Cellpose for cell segmentation.
 
@@ -102,7 +102,7 @@ Compute Apps are the backend services that perform computations. In this example
          max_replicas: 2
      ```
 
-#### Step 3: Develop the UI App
+## Step 3: Develop the UI App
 
 UI Apps are web-based interfaces that interact with the Compute Apps. In this example, we’ll create a simple ImJoy plugin for image visualization and interaction with the Compute App.
 
@@ -155,7 +155,7 @@ UI Apps are web-based interfaces that interact with the Compute Apps. In this ex
      </script>
      ```
 
-#### Step 4: Testing Your BioEngine App
+## Step 4: Testing Your BioEngine App
 
 1. **Run the Compute App:**
    - If you're running the Compute App locally:
@@ -168,7 +168,7 @@ UI Apps are web-based interfaces that interact with the Compute Apps. In this ex
    - Drag and drop the `image_viewer.imjoy.html` file into the ImJoy interface.
    - Run the plugin and check the console for outputs.
 
-#### Step 5: Submitting Your App to BioEngine
+## Step 5: Submitting Your App to BioEngine
 
 1. **Prepare Your Files for Submission:**
    - Ensure that your `__init__.py` and `manifest.yaml` files are complete and tested.
@@ -181,7 +181,7 @@ UI Apps are web-based interfaces that interact with the Compute Apps. In this ex
    - Provide a detailed description of your app, including its functionality, dependencies, and any special instructions.
    - The BioEngine team will review your submission and provide feedback or merge it into the main repository.
 
-#### Conclusion
+## Conclusion
 
 Congratulations! You've created and submitted a BioEngine App. This tutorial has guided you through the development of both UI and Compute Apps, from setup to submission. By contributing to BioEngine, you’re helping to expand a powerful platform for bioimage analysis and AI-driven research.