diff --git a/.github/workflows/wiki.yml b/.github/workflows/wiki.yml new file mode 100644 index 000000000..e903bd6b2 --- /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: # 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 + +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 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 \ No newline at end of file diff --git a/README.md b/README.md index ea3c11e9f..a090db7a8 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). + + 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--Troubleshooting.md similarity index 100% rename from docs/troubleshooting.md rename to docs/06--Troubleshooting.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 000000000..701d3b7a2 --- /dev/null +++ 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! \ No newline at end of file