doc: align folder structure (#61)

* doc: align folder structure Moved doc files into a new structure. Edited workflow files accordingly. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no> * Feat: update shared * update zoomin python script Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no> --------- Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no> Co-authored-by: Kyle Micallef Bonnici <kyle.bonnici@nordicsemi.no>
NordicSemiconductor · Dec 18, 2023 · 2b4f934 · 2b4f934
1 parent 38e458a
commit 2b4f934
Show file tree

Hide file tree

Showing 17 changed files with 14 additions and 15 deletions.
diff --git a/.github/workflows/zoomin-publish-dev.yml b/.github/workflows/zoomin-publish-dev.yml
@@ -5,7 +5,7 @@ on:
     branches:
       - main
     paths:
-      - docs
+      - doc/docs
   workflow_dispatch:
 
 jobs:

diff --git a/.github/workflows/zoomin.yml b/.github/workflows/zoomin.yml
@@ -16,16 +16,15 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Copy zoomin properties
-        run: cp docs/zoomin/* .
-
-      - name: Replace index.md
-        run: cp docs/zoomin/index.md docs/index.md
+        run: |
+          cp doc/zoomin/custom.properties doc/ \
+          && cp doc/zoomin/tags.yml doc/
 
       - name: Create zip file
         run: |
-          zip -r nrf-connect-serial-terminal.zip \
-            docs mkdocs.yml custom.properties tags.yml \
-            -x@docs/zoomin/ignore.txt
+          cd doc/ \
+          && zip -r ../nrf-connect-serial-terminal.zip \
+          docs/* mkdocs.yml custom.properties tags.yml
 
       - name: Upload documentation artifact
         uses: actions/upload-artifact@v3

diff --git a/docs/configuration.md → doc/docs/configuration.md b/docs/configuration.md → doc/docs/configuration.md
diff --git a/docs/configuring_serial_port.md → doc/docs/configuring_serial_port.md b/docs/configuring_serial_port.md → doc/docs/configuring_serial_port.md
diff --git a/docs/getting_started.md → doc/docs/getting_started.md b/docs/getting_started.md → doc/docs/getting_started.md
diff --git a/docs/index.md → doc/docs/index.md b/docs/index.md → doc/docs/index.md
diff --git a/docs/installing.md → doc/docs/installing.md b/docs/installing.md → doc/docs/installing.md
diff --git a/docs/revision_history.md → doc/docs/revision_history.md b/docs/revision_history.md → doc/docs/revision_history.md
diff --git a/...screenshots/serial_term_select_device.png → ...screenshots/serial_term_select_device.png b/...screenshots/serial_term_select_device.png → ...screenshots/serial_term_select_device.png
diff --git a/.../screenshots/serial_term_serial_ports.png → .../screenshots/serial_term_serial_ports.png b/.../screenshots/serial_term_serial_ports.png → .../screenshots/serial_term_serial_ports.png
diff --git a/docs/selecting_serial_port.md → doc/docs/selecting_serial_port.md b/docs/selecting_serial_port.md → doc/docs/selecting_serial_port.md
diff --git a/docs/troubleshooting.md → doc/docs/troubleshooting.md b/docs/troubleshooting.md → doc/docs/troubleshooting.md
diff --git a/mkdocs.yml → doc/mkdocs.yml b/mkdocs.yml → doc/mkdocs.yml
diff --git a/custom.properties → doc/zoomin/custom.properties b/custom.properties → doc/zoomin/custom.properties
diff --git a/tags.yml → doc/zoomin/tags.yml b/tags.yml → doc/zoomin/tags.yml
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -42,7 +42,7 @@
         "prepare": "husky install"
     },
     "devDependencies": {
-        "@nordicsemiconductor/pc-nrfconnect-shared": "^142.0.0",
+        "@nordicsemiconductor/pc-nrfconnect-shared": "^143.0.0",
         "ansi-escapes": "^4.3.2",
         "serialport": "^10.5.0",
         "xterm-addon-fit": "^0.8.0",
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,7 +5,7 @@ on: @@
         branches:
           - main
         paths:
-          - docs
+          - doc/docs
       workflow_dispatch:
     jobs:
@@ Expand Down @@