Update doc structure

theEvilReaper · Jan 16, 2024 · 50020da · 50020da
1 parent 348b8b9
commit 50020da
Show file tree

Hide file tree

Showing 21 changed files with 106 additions and 3 deletions.
diff --git a/.github/workflows/writerside.yml b/.github/workflows/writerside.yml
@@ -0,0 +1,103 @@
+name: Build documentation
+
+on:
+  # If specified, the workflow will be triggered automatically once you push to the `main` branch.
+  # Replace `main` with your branch’s name
+  push:
+    branches: ["feature/docs"]
+  # Specify to run a workflow manually from the Actions tab on GitHub
+  workflow_dispatch:
+
+# Gives the workflow permissions to clone the repo and create a page deployment
+permissions:
+  id-token: write
+  pages: write
+
+env:
+  # Name of module and id separated by a slash
+  INSTANCE: Writerside/docs
+  # Replace HI with the ID of the instance in capital letters
+  ARTIFACT: webHelpDOCS2-all.zip
+  # Writerside docker image version
+  DOCKER_VERSION: 232.10275
+  # Add the variable below to upload Algolia indexes
+  # Replace HI with the ID of the instance in capital letters
+  ALGOLIA_ARTIFACT: algolia-indexes-DOCS.zip
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Build Writerside docs using Docker
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          artifact: ${{ env.ARTIFACT }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+
+      - name: Upload documentation
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs
+          path: |
+            artifacts/${{ env.ARTIFACT }}
+            artifacts/report.json
+          retention-days: 7
+
+      # Add the step below to upload Algolia indexes
+      - name: Upload algolia-indexes
+        uses: actions/upload-artifact@v3
+        with:
+          name: algolia-indexes
+          path: artifacts/${{ env.ALGOLIA_ARTIFACT }}
+          retention-days: 7
+
+  # Add the job below and artifacts/report.json on Upload documentation step above if you want to fail the build when documentation contains errors
+  test:
+    # Requires build job results
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v1
+        with:
+          name: docs
+          path: artifacts
+
+      - name: Test documentation
+        uses: JetBrains/writerside-checker-action@v1
+        with:
+          instance: ${{ env.INSTANCE }}
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    # Requires the build job results
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+
+      - name: Unzip artifact
+        run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: dir
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1
diff --git a/docs/c.list → Writerside/c.list b/docs/c.list → Writerside/c.list
diff --git a/docs/redirection-rules.xml → Writerside/redirection-rules.xml b/docs/redirection-rules.xml → Writerside/redirection-rules.xml
diff --git a/docs/topics/Functions.md → Writerside/topics/Functions.md b/docs/topics/Functions.md → Writerside/topics/Functions.md
diff --git a/docs/topics/class.md → Writerside/topics/class.md b/docs/topics/class.md → Writerside/topics/class.md
diff --git a/docs/topics/classes/classes.md → Writerside/topics/classes/classes.md b/docs/topics/classes/classes.md → Writerside/topics/classes/classes.md
diff --git a/docs/topics/classes/enum.md → Writerside/topics/classes/enum.md b/docs/topics/classes/enum.md → Writerside/topics/classes/enum.md
diff --git a/docs/topics/contributing.md → Writerside/topics/contributing.md b/docs/topics/contributing.md → Writerside/topics/contributing.md
diff --git a/docs/topics/overview.md → Writerside/topics/overview.md b/docs/topics/overview.md → Writerside/topics/overview.md
diff --git a/docs/topics/placeholders.md → Writerside/topics/placeholders.md b/docs/topics/placeholders.md → Writerside/topics/placeholders.md
diff --git a/docs/topics/starter-topic.md → Writerside/topics/starter-topic.md b/docs/topics/starter-topic.md → Writerside/topics/starter-topic.md
@@ -1,7 +1,7 @@
 # About Wiki
 
-<!--docs adds this topic when you create a new documentation project.
-You can use it as a sandbox to play with docs features, and remove it from the TOC when you don't need it anymore.-->
+<!--Writerside adds this topic when you create a new documentation project.
+You can use it as a sandbox to play with Writerside features, and remove it from the TOC when you don't need it anymore.-->
 
 ## Add new topics
 You can create empty topics, or choose a template for different types of content that contains some boilerplate structure to help you get started:

diff --git a/docs/topics/variables.md → Writerside/topics/variables.md b/docs/topics/variables.md → Writerside/topics/variables.md
diff --git a/docs/v.list → Writerside/v.list b/docs/v.list → Writerside/v.list
diff --git a/docs/w.tree → Writerside/w.tree b/docs/w.tree → Writerside/w.tree
diff --git a/docs/writerside.cfg → Writerside/writerside.cfg b/docs/writerside.cfg → Writerside/writerside.cfg
@@ -4,6 +4,6 @@
 <ihp version="2.0">
     <topics dir="topics" web-path="topics"/>
     <images dir="images" web-path="images"/>
-    <instance src="w.tree" web-path="/w/" version="1.0.0"/>
+    <instance src="w.tree" web-path="/docs/" version="1.0.0"/>
 
 </ihp>
diff --git a/docs/images/completion_procedure.png b/docs/images/completion_procedure.png
diff --git a/docs/images/completion_procedure_dark.png b/docs/images/completion_procedure_dark.png
diff --git a/docs/images/convert_table_to_xml.png b/docs/images/convert_table_to_xml.png
diff --git a/docs/images/convert_table_to_xml_dark.png b/docs/images/convert_table_to_xml_dark.png
diff --git a/docs/images/new_topic_options.png b/docs/images/new_topic_options.png
diff --git a/docs/images/new_topic_options_dark.png b/docs/images/new_topic_options_dark.png