chaiNNer-org · oumad · Jan 2, 2025 · Jan 2, 2025 · Jan 2, 2025 · Jan 2, 2025
diff --git a/.github/workflows/wiki.yml b/.github/workflows/wiki.yml
@@ -0,0 +1,44 @@
+name: Publish Wiki
+
+# Trigger this action only if there are changes pushed to the wiki/** directory under the main branch
+on:
+  push:
+    paths:
+      - docs/** # This includes all sub folders
+    branches:
+      - main # This can be changed to any branch of your preference
+
+env:
+  USER_TOKEN: <USER_TOKEN_ENV_VARIABLE> # This is the repository secret
+  USER_NAME: <USER_NAME> # Enter the username of your (bot) account
+  USER_EMAIL: <USER_EMAIL> # Enter the e-mail of your (bot) account
+  OWNER: ${{ github.event.repository.owner.login }} # This is the repository owner
+  REPOSITORY_NAME: ${{ github.event.repository.name }} # This is the repository name
+
+jobs:
+  publish_wiki:
+    name: Publish wiki
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Pull content from wiki
+        run: |
+          mkdir tmp_wiki
+          cd tmp_wiki
+          git init
+          git config user.name $USER_NAME
+          git config user.email $USER_EMAIL
+          git remote add origin https://[email protected]/$OWNER/$REPOSITORY_NAME.wiki.git
+          git fetch origin
+          git checkout master || git checkout -b master
+          git pull origin master
+
+      - name: Push content to wiki
+        run: |
+          rsync -av --delete docs/ tmp_wiki/ --exclude .git
+          cd tmp_wiki
+          git add .
+          git commit -m "Update Wiki content" || echo "No changes to commit"
+          git push origin master
diff --git a/README.md b/README.md
@@ -123,12 +123,18 @@ As of v0.21.0, chaiNNer uses our new package called [Spandrel](https://github.co
 
 ## Troubleshooting
 
-For troubleshooting information, view the [troubleshooting document](docs/troubleshooting.md).
+For troubleshooting information, view the [troubleshooting document](https://github.com/chaiNNer-org/chaiNNer/wiki/06--Troubleshooting).
 
 ## Building chaiNNer Yourself
 
 I provide pre-built versions of chaiNNer here on GitHub. However, if you would like to build chaiNNer yourself, simply run `npm install` (make sure that you have at least npm v7 installed) to install all the nodejs dependencies, and `npm run make` to build the application.
 
 ## FAQ
 
-For FAQ information, view the [FAQ document](docs/FAQ.md).
+For FAQ information, view the [FAQ document](https://github.com/chaiNNer-org/chaiNNer/wiki/07--FAQ).
+
+## Documentation
+
+For in-depth documentation covering various aspects of ChaiNNer, including CLI usage, data representation, and a contributor's guide, kindly refer to our [ChaiNNer Wiki](https://github.com/chaiNNer-org/chaiNNer/wiki).
+
+
diff --git a/docs/CONTRIBUTING.md → docs/01--Contributing.md b/docs/CONTRIBUTING.md → docs/01--Contributing.md
diff --git a/docs/data-representation.md → docs/02--Data-Representation.md b/docs/data-representation.md → docs/02--Data-Representation.md
diff --git a/docs/nodes.md → docs/03--Nodes.md b/docs/nodes.md → docs/03--Nodes.md
diff --git a/docs/navi.md → docs/04--Navi.md b/docs/navi.md → docs/04--Navi.md
diff --git a/docs/cli.md → docs/05--CLI.md b/docs/cli.md → docs/05--CLI.md
diff --git a/docs/troubleshooting.md → docs/06--Troubleshooting.md b/docs/troubleshooting.md → docs/06--Troubleshooting.md
diff --git a/docs/FAQ.md → docs/07--FAQ.md b/docs/FAQ.md → docs/07--FAQ.md
diff --git a/docs/Home.md b/docs/Home.md
@@ -0,0 +1,27 @@
+# Welcome to the ChaiNNer Wiki !
+
+This wiki serves as a comprehensive guide to ChaiNNer, a visual programming language and development environment for chaining image processing tasks together. Below are the key sections of the documentation:
+
+## Table of Contents
+
+**[[01--Contributing]]** - *Overview of how to contribute to the ChaiNNer project, with setup instructions and project structure.*
+
+**[[02--Data-Representation]]** - *Details on how ChaiNNer handles various data types such as images, text, and numbers, along with conventions for node implementations.*
+
+**[[03--Nodes]]** - *Information about nodes in ChaiNNer, covering their structure, rules, and methods for implementation.*
+
+**[[04--Navi]]** - *Overview of the Navi type system used for static validation and real-time feedback in ChaiNNer.*
+
+**[[05--CLI]]** - *Instructions for operating ChaiNNer in command-line interface mode, allowing for chain execution without a GUI.*
+
+**[[06--Troubleshooting]]** - *Solutions to common issues encountered while using ChaiNNer, addressing installation and runtime problems.*
+
+**[[07--FAQ]]** - *Answers to frequently asked questions about ChaiNNer, including feature requests and usage scenarios.*
+
+## Additional Resources
+
+For more information, check out the individual sections linked above. If you have any questions or need further assistance, feel free to reach out to the community in [discord](https://discord.gg/pzvAKPKyHM) or [open an issue](https://github.com/chaiNNer-org/chaiNNer/issues) on the GitHub repository.
+
+---
+
+Thank you for visiting the ChaiNNer wiki!