Merge pull request #4 from ReneSchwarzer/develop

0.0.8-alpha

Author: ReneSchwarzer

.github/workflows/generate-docs.yml

@@ -0,0 +1,52 @@
+name: Generate and Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  actions: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  publish-docs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Setup .NET SDK
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: 9.x
+
+    - name: Install DocFX
+      run: dotnet tool install -g docfx
+
+    - name: Add DocFX to PATH
+      run: echo "$HOME/.dotnet/tools" >> $GITHUB_PATH
+
+    - name: Generate documentation
+      run: |
+        cd docs 
+        docfx metadata
+        docfx build
+
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: '_site'
+
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

README.md

@@ -1,41 +1,45 @@
-![WebExpress](https://raw.githubusercontent.com/ReneSchwarzer/WebExpress.Doc/main/assets/banner.png)
+![WebExpress](https://raw.githubusercontent.com/ReneSchwarzer/WebExpress/main/assets/banner.png)
 
 # WebExpress
-WebExpress is a lightweight web server optimized for use in low-performance environments (e.g. Rasperry PI). By providing 
+`WebExpress` is a lightweight web server optimized for use in low-performance environments (e.g. Rasperry PI). By providing 
 a powerful plugin system and a comprehensive API, web applications can be easily and quickly integrated into a .net 
-language (e.g. C#). Some advantages of WebExpress are:
+language (e.g. C#). Some advantages of `WebExpress` are:
 
 - It is easy to use.
 - It offers a variety of features and tools that can help you build and manage your website.
 - It is fast and efficient and can help you save time and money.
 - It is flexible and can be customized to meet your specific requirements.
 
-The WebExpress family includes the following projects:
+The `WebExpress` family includes the following projects:
 
-- [WebExpress](https://github.com/ReneSchwarzer/WebExpress#readme) - The web server for WebExpress applications and the documentation.
-- [WebExpress.WebCore](https://github.com/ReneSchwarzer/WebExpress.WebCore#readme) - The core for WebExpress applications.
-- [WebExpress.WebUI](https://github.com/ReneSchwarzer/WebExpress.WebUI#readme) - Common templates and controls for WebExpress applications.
-- [WebExpress.WebIndex](https://github.com/ReneSchwarzer/WebExpress.WebIndex#readme) - Reverse index for WebExpress applications.
-- [WebExpress.WebApp](https://github.com/ReneSchwarzer/WebExpress.WebApp#readme) - Business application template for WebExpress applications.
+- [WebExpress](https://github.com/ReneSchwarzer/WebExpress#readme) - The web server for `WebExpress` applications and the documentation.
+- [WebExpress.WebCore](https://github.com/ReneSchwarzer/WebExpress.WebCore#readme) - The core for `WebExpress` applications.
+- [WebExpress.WebUI](https://github.com/ReneSchwarzer/WebExpress.WebUI#readme) - Common templates and controls for `WebExpress` applications.
+- [WebExpress.WebIndex](https://github.com/ReneSchwarzer/WebExpress.WebIndex#readme) - Reverse index for `WebExpress` applications.
+- [WebExpress.WebApp](https://github.com/ReneSchwarzer/WebExpress.WebApp#readme) - Business application template for `WebExpress` applications.
 
 # WebExpress.WebIndex
-WebExpress.WebIndex is part of the WebExpress family. The project provides a reverse index 
-to enable a quick and efficient search for data. The index can be filtered using the 
-wql (webexpress query language). Even though the reverse index is part of the WebExpress 
-family, it can also be used in other projects (outside of WebExpress).
-For detailed information about WebIndex, see [concept](https://github.com/ReneSchwarzer/WebExpress.WebIndex/blob/main/doc/concept.md).
+`WebExpress.WebIndex` is part of the WebExpress family. The project provides a reverse index to enable a quick and efficient search for data. The index can be filtered using the wql (webexpress query language). Even though the reverse index is part of the `WebExpress` family, it can also be used in other projects (outside of `WebExpress`). For detailed information about `WebIndex`, see [concept](https://github.com/ReneSchwarzer/WebExpress.WebIndex/blob/main/docs/concept.md).
 
 # Download 
 The current binaries are available for download [here](https://github.com/ReneSchwarzer/WebExpress/releases).
 
 # Start
-To get started with WebExpress, use the following links and tutorials.
+If you're looking to get started with `WebExpress`, we would recommend using the following documentation. It can help you understand the platform.
 
-- [installation guide](https://github.com/ReneSchwarzer/WebExpress/blob/main/doc/installation_guide.md) 
-- [development guide](https://github.com/ReneSchwarzer/WebExpress/blob/main/doc/development_guide.md)
+- [Installation Guide](https://github.com/ReneSchwarzer/WebExpress/blob/main/doc/installation_guide.md) 
+- [Development Guide](https://github.com/ReneSchwarzer/WebExpress/blob/main/doc/development_guide.md)
+- [WebExpress.WebCore API Documentation](https://reneschwarzer.github.io/WebExpress.WebCore/) 
+- [WebExpress.WebUI API Documentation](https://reneschwarzer.github.io/WebExpress.WebUI/) 
+- [WebExpress.WebApp API Documentation](https://reneschwarzer.github.io/WebExpress.WebApp/) 
+- [WebExpress.WebIndex API Documentation](https://reneschwarzer.github.io/WebExpress.WebIndex/) 
+
+# Learning
+The following tutorials illustrate the essential techniques of `WebExpress`. These tutorials are designed to assist you, as a developer, in understanding the various aspects of `WebExpress`. Each tutorial provides a detailed, step-by-step guide that you can work through using an example. If you’re interested in beginning the development of `WebExpress` components, we would recommend you to complete some of these tutorials.
 
-## Tutorials
 - [HelloWorld](https://github.com/ReneSchwarzer/WebExpress.Tutorial.HelloWorld#readme)
+- [WebApp](https://github.com/ReneSchwarzer/WebExpress.Tutorial.WebApp#readme)
+- [WebIndex](https://github.com/ReneSchwarzer/WebExpress.Tutorial.WebIndex#readme)
 
 # Tags
-#WebExpress #ReverseIndex
+#WebIndex #WebExpress #ReverseIndex #DotNet #NETCore