From 0dcc5195c1e6029062b2f755f755d22815f125a7 Mon Sep 17 00:00:00 2001 From: Mohamed Oumoumad Date: Thu, 2 Jan 2025 01:38:34 +0100 Subject: [PATCH 1/7] changed the doc files and added workflow for wiki --- .github/workflows/wiki.yml | 44 +++++++++++++++++++ docs/{CONTRIBUTING.md => 01--Contributing.md} | 0 ...entation.md => 02--Data-Representation.md} | 0 docs/{nodes.md => 03--Nodes.md} | 0 docs/{navi.md => 04--Navi.md} | 0 docs/{cli.md => 05--CLI.md} | 0 ...ubleshooting.md => 06--Troobleshooting.md} | 0 docs/{FAQ.md => 07--FAQ.md} | 0 docs/Home.md | 21 +++++++++ 9 files changed, 65 insertions(+) create mode 100644 .github/workflows/wiki.yml rename docs/{CONTRIBUTING.md => 01--Contributing.md} (100%) rename docs/{data-representation.md => 02--Data-Representation.md} (100%) rename docs/{nodes.md => 03--Nodes.md} (100%) rename docs/{navi.md => 04--Navi.md} (100%) rename docs/{cli.md => 05--CLI.md} (100%) rename docs/{troubleshooting.md => 06--Troobleshooting.md} (100%) rename docs/{FAQ.md => 07--FAQ.md} (100%) create mode 100644 docs/Home.md diff --git a/.github/workflows/wiki.yml b/.github/workflows/wiki.yml new file mode 100644 index 0000000000..0d0fc05e7c --- /dev/null +++ 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: ${{ secrets.GEARTRACKER_USER_GH_TOKEN }} # This is the repository secret + USER_NAME: geartracker # Enter the username of your (bot) account + USER_EMAIL: gtracker@gear-productions.com # 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://$USER_TOKEN@github.com/$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 wiki/ tmp_wiki/ --exclude .git + cd tmp_wiki + git add . + git commit -m "Update Wiki content" || echo "No changes to commit" + git push origin master \ No newline at end of file diff --git a/docs/CONTRIBUTING.md b/docs/01--Contributing.md similarity index 100% rename from docs/CONTRIBUTING.md rename to docs/01--Contributing.md diff --git a/docs/data-representation.md b/docs/02--Data-Representation.md similarity index 100% rename from docs/data-representation.md rename to docs/02--Data-Representation.md diff --git a/docs/nodes.md b/docs/03--Nodes.md similarity index 100% rename from docs/nodes.md rename to docs/03--Nodes.md diff --git a/docs/navi.md b/docs/04--Navi.md similarity index 100% rename from docs/navi.md rename to docs/04--Navi.md diff --git a/docs/cli.md b/docs/05--CLI.md similarity index 100% rename from docs/cli.md rename to docs/05--CLI.md diff --git a/docs/troubleshooting.md b/docs/06--Troobleshooting.md similarity index 100% rename from docs/troubleshooting.md rename to docs/06--Troobleshooting.md diff --git a/docs/FAQ.md b/docs/07--FAQ.md similarity index 100% rename from docs/FAQ.md rename to docs/07--FAQ.md diff --git a/docs/Home.md b/docs/Home.md new file mode 100644 index 0000000000..88ed0c3301 --- /dev/null +++ b/docs/Home.md @@ -0,0 +1,21 @@ +# 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! \ No newline at end of file From f1593ceaade30f1e58cc354a468db1685f2230fd Mon Sep 17 00:00:00 2001 From: Mohamed Oumoumad Date: Thu, 2 Jan 2025 01:56:19 +0100 Subject: [PATCH 2/7] changed branch for test --- .github/workflows/wiki.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/wiki.yml b/.github/workflows/wiki.yml index 0d0fc05e7c..03c0ccc44a 100644 --- a/.github/workflows/wiki.yml +++ b/.github/workflows/wiki.yml @@ -6,7 +6,7 @@ on: paths: - docs/** # This includes all sub folders branches: - - main # This can be changed to any branch of your preference + - misc/wiki-workflow # This can be changed to any branch of your preference env: USER_TOKEN: ${{ secrets.GEARTRACKER_USER_GH_TOKEN }} # This is the repository secret From ce7f0de19cc7164f615f113df76d9db987c4d683 Mon Sep 17 00:00:00 2001 From: Mohamed Oumoumad Date: Thu, 2 Jan 2025 02:01:22 +0100 Subject: [PATCH 3/7] workflow push test --- .github/workflows/wiki.yml | 2 +- docs/Home.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/wiki.yml b/.github/workflows/wiki.yml index 03c0ccc44a..36ca8d10c3 100644 --- a/.github/workflows/wiki.yml +++ b/.github/workflows/wiki.yml @@ -37,7 +37,7 @@ jobs: - name: Push content to wiki run: | - rsync -av --delete wiki/ tmp_wiki/ --exclude .git + rsync -av --delete docs/ tmp_wiki/ --exclude .git cd tmp_wiki git add . git commit -m "Update Wiki content" || echo "No changes to commit" diff --git a/docs/Home.md b/docs/Home.md index 88ed0c3301..3717b0aa26 100644 --- a/docs/Home.md +++ b/docs/Home.md @@ -1,4 +1,4 @@ -# Welcome to the ChaiNNer Wiki! +# 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: From 077dbb43ed50ca7343a1a14fb7d9761e0083dc22 Mon Sep 17 00:00:00 2001 From: Mohamed Oumoumad Date: Thu, 2 Jan 2025 02:16:56 +0100 Subject: [PATCH 4/7] fixed home and troubleshooting file name --- docs/{06--Troobleshooting.md => 06--Troubleshooting.md} | 0 docs/Home.md | 6 ++++++ 2 files changed, 6 insertions(+) rename docs/{06--Troobleshooting.md => 06--Troubleshooting.md} (100%) diff --git a/docs/06--Troobleshooting.md b/docs/06--Troubleshooting.md similarity index 100% rename from docs/06--Troobleshooting.md rename to docs/06--Troubleshooting.md diff --git a/docs/Home.md b/docs/Home.md index 3717b0aa26..701d3b7a2e 100644 --- a/docs/Home.md +++ b/docs/Home.md @@ -5,11 +5,17 @@ This wiki serves as a comprehensive guide to ChaiNNer, a visual programming lang ## 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 From 82437604b0796ec176179a94eeabc65220beb800 Mon Sep 17 00:00:00 2001 From: Mohamed Oumoumad Date: Thu, 2 Jan 2025 02:36:08 +0100 Subject: [PATCH 5/7] switch workflow back for main --- .github/workflows/wiki.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/wiki.yml b/.github/workflows/wiki.yml index 36ca8d10c3..0d79b6feae 100644 --- a/.github/workflows/wiki.yml +++ b/.github/workflows/wiki.yml @@ -6,7 +6,7 @@ on: paths: - docs/** # This includes all sub folders branches: - - misc/wiki-workflow # This can be changed to any branch of your preference + - main # This can be changed to any branch of your preference env: USER_TOKEN: ${{ secrets.GEARTRACKER_USER_GH_TOKEN }} # This is the repository secret From 93a7a5a9a4767e1c3ef5b667f22aec56aa8dc797 Mon Sep 17 00:00:00 2001 From: Mohamed Oumoumad Date: Thu, 2 Jan 2025 02:44:59 +0100 Subject: [PATCH 6/7] changed personal token and email with placeholders --- .github/workflows/wiki.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/wiki.yml b/.github/workflows/wiki.yml index 0d79b6feae..e903bd6b27 100644 --- a/.github/workflows/wiki.yml +++ b/.github/workflows/wiki.yml @@ -9,9 +9,9 @@ on: - main # This can be changed to any branch of your preference env: - USER_TOKEN: ${{ secrets.GEARTRACKER_USER_GH_TOKEN }} # This is the repository secret - USER_NAME: geartracker # Enter the username of your (bot) account - USER_EMAIL: gtracker@gear-productions.com # Enter the e-mail of your (bot) account + USER_TOKEN: # This is the repository secret + USER_NAME: # Enter the username of your (bot) account + 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 From e6981d6b3ccdfd7526ba4e79813d32d721ad1f4e Mon Sep 17 00:00:00 2001 From: Mohamed Oumoumad Date: Thu, 2 Jan 2025 08:42:34 +0100 Subject: [PATCH 7/7] README document links now point to the wiki --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ea3c11e9fb..a090db7a89 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ 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 @@ -131,4 +131,10 @@ I provide pre-built versions of chaiNNer here on GitHub. However, if you would l ## 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). + +