add website (#13)

.config/dotnet-tools.json

@@ -0,0 +1,18 @@
+{
+    "version": 1,
+    "isRoot": true,
+    "tools": {
+      "dotnet-repl": {
+        "version": "0.1.205",
+        "commands": [
+          "dotnet-repl"
+        ]
+      },
+      "docfx": {
+        "version": "2.67.5",
+        "commands": [
+          "docfx"
+        ]
+      }
+    }
+  }

.github/workflows/gh-page.yml

@@ -0,0 +1,82 @@
+# Your GitHub workflow file under .github/workflows/
+# Trigger the action on push to main
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+  schedule:
+    # * is a special character in YAML so you have to quote this string
+    - cron:  '30 5,17 * * *'
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  actions: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+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:
+    # checkout autogen library
+    # url: https://github.com/microsoft/autogen/tree/dotnet
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: ls
+      run: ls
+    - name: Dotnet Setup
+      uses: actions/setup-dotnet@v3
+      with:
+        global-json-file: global.json
+
+    - run: dotnet tool update -g docfx
+    - run: docfx website/docfx.json
+
+    - name: insert clarity snippet to website/_site/index.html
+      run: |
+        import os
+        clarity_script = """
+        <script type="text/javascript">
+            (function(c,l,a,r,i,t,y){
+                c[a]=c[a]||function(){(c[a].q=c[a].q||[]).push(arguments)};
+                t=l.createElement(r);t.async=1;t.src="https://www.clarity.ms/tag/"+i;
+                y=l.getElementsByTagName(r)[0];y.parentNode.insertBefore(t,y);
+            })(window, document, "clarity", "script", "o1x9ju6yyh");
+        </script>
+        """
+
+        site_folder = 'website/_site/'
+
+        for root, dirs, files in os.walk(site_folder):
+            for file in files:
+                if file.endswith('.html'):
+                    html_path = os.path.join(root, file)
+
+                    # insert the script into the html's head section
+                    with open(html_path, 'r') as file:
+                        html = file.read()
+                        html = html.replace('</head>', clarity_script + '</head>')
+
+                    with open(html_path, 'w') as file:
+                        file.write(html)
+
+                    print(f'Clarity script inserted into {html_path}')
+      shell: python
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        # Upload entire repository
+        path: 'website/_site'
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

README.md

@@ -100,7 +100,7 @@ stopwatch.ElapsedMilliseconds.Should().BeLessThan(6000);
 ```
 
 ## Examples
-You can find more examples in the [examples](./example) directory.
+You can find more examples in the [examples](https://github.com/LittleLittleCloud/StepWise/tree/main/example) directory.
 
 ## Dependency Management between Steps
 ### Step Dependency
@@ -124,7 +124,7 @@ StepWise automatically manages dependencies between Steps:
 StepWise supports parallel execution of steps that do not have step dependencies on each other. This can significantly improve the performance of your workflows by executing independent steps concurrently.
 
 ## `StepWiseEngine`
-`StepWiseEngine` is the core component of StepWise that manages the execution of workflows. It uses a consumer-producer approach to execute steps in the correct order while handling dependencies between steps and parallel execution when possible. You can visit this [documentation](./docs/DeepDiveToStepWiseEngine.md) to learn more about how the `StepWiseEngine` works.
+`StepWiseEngine` is the core component of StepWise that manages the execution of workflows. It uses a consumer-producer approach to execute steps in the correct order while handling dependencies between steps and parallel execution when possible. You can visit this [documentation](./article/DeepDiveToStepWiseEngine.md) to learn more about how the `StepWiseEngine` works.
 
 ## Primitives
 
@@ -175,11 +175,11 @@ A Workflow is a collection of Steps that together accomplish a larger task.
 
 ## Contributing
 
-We welcome contributions to StepWise! Please see our [Contributing Guide](CONTRIBUTING.md) for more details.
+We welcome contributions to StepWise! Please see our [Contributing Guide](https://github.com/LittleLittleCloud/StepWise/tree/main/CONTRIBUTING.md) for more details.
 
 ## License
 
-StepWise is released under the MIT License. See the [LICENSE](LICENSE) file for details.
+StepWise is released under the MIT License. See the [LICENSE](https://github.com/LittleLittleCloud/StepWise/tree/main/LICENSE) file for details.
 
 ## Support
 

website/.gitignore

@@ -0,0 +1,12 @@
+###############
+#    folder   #
+###############
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+
+# build artifacts for web
+_site/
+api/

website/article/Deep_Dive_To_StepWise_Engine.md

@@ -0,0 +1 @@
+[!INCLUDE [](../../article/DeepDiveToStepWiseEngine.md)]

website/article/toc.yml

@@ -0,0 +1,2 @@
+- name: Deep Dive to Step Wise Engine
+  href: Deep_Dive_To_StepWise_Engine.md

website/docfx.json

@@ -0,0 +1,96 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": ["src/**/*.csproj"],
+          "src": "../",
+          "exclude": [
+            "**/bin/**",
+            "**/obj/**"
+          ]
+        }
+      ],
+      "dest": "api",
+      "includePrivateMembers": false,
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false,
+      "noRestore": false,
+      "namespaceLayout": "flattened",
+      "memberLayout": "samePage",
+      "allowCompilationErrors": false,
+      "filter": "filterConfig.yml"
+    }
+  ],
+    "build": {
+      "content": [
+        {
+          "files": [
+            "api/**.yml",
+            "api/index.md"
+          ]
+        },
+        {
+          "files": [
+            "article/**.md",
+            "article/**/toc.yml",
+            "toc.yml",
+            "**/toc.yml",
+            "get_start/**.md",
+            "release_notes/**.md",
+            "*.md"
+          ]
+        },
+        {
+          "files": [
+            "**.md"
+          ],
+          "src": "../article",
+          "dest": "article"
+        }
+      ],
+      "resource": [
+        {
+          "files": [
+            "favicon.ico"
+          ]
+        },
+        {
+          "files": [
+            "**.*"
+          ],
+          "src": "../asset",
+          "dest": "asset"
+        }
+      ],
+      "sitemap": {
+        "baseUrl": "https://littlelittlecloud.github.io/StepWise",
+        "priority": 0.5,
+        "changefreq": "daily"
+      },
+      "output": "_site",
+      "globalMetadataFiles": [],
+      "fileMetadataFiles": [],
+      "template": [
+        "default",
+        "modern",
+        "template"
+      ],
+      "globalMetadata":{
+        "_appTitle": "StepWise",
+        "_appName": "StepWise",
+        "_appLogoPath": "asset/stepwise-logo-20-20.svg",
+        "_gitContribute": {
+          "repo": "https://github.com/LittleLittleCloud/StepWise.git",
+          "branch": "main"
+        },
+        "_enableSearch": true,
+        "_disableBreadcrumb": true,
+        "_disableContribution": false,
+        "_gitUrlPattern": "github"
+      },
+      "postProcessors": [],
+      "keepFileLink": false,
+      "disableGitFeatures": false
+    }
+  }

website/filterConfig.yml

@@ -0,0 +1,3 @@
+apiRules:
+- include:
+    uidRegex: ^StepWise

website/index.md

@@ -0,0 +1 @@
+[!INCLUDE [](../README.md)]

website/release_notes/0_0.md

@@ -0,0 +1 @@
+# Coming Soon

website/release_notes/toc.yml

@@ -0,0 +1,2 @@
+- name: 0.0.*
+  href: 0_0.md

website/template/public/main.js

@@ -0,0 +1,9 @@
+export default {
+    iconLinks: [
+      {
+        icon: 'github',
+        href: 'https://github.com/LittleLittleCloud/StepWise',
+        title: 'GitHub'
+      }
+    ]
+  }

website/toc.yml

@@ -0,0 +1,9 @@
+
+- name: API Reference
+  href: api/
+
+- name: Release Notes
+  href: release_notes/
+
+- name: Article
+  href: article/