Merge branch 'master' into JennyBranch

Author: Jenny-Jiani

.github/workflows/full-site-build.yml

@@ -30,11 +30,15 @@ jobs:
       - name: Run a multi-line script
         run: |
           cd /home/ubuntu
-          [ ! -d DLRDoc ] && mkdir -p DLRDoc
-          [ ! -d label-recognition-docs ] && git clone --depth 1 https://github.com/Dynamsoft/label-recognition-docs.git
-          cd label-recognition-docs && git pull && cd .. && cp -rfp ./label-recognition-docs/* ./DLRDoc/
-          cd Docs-Template-Repo-Preview && git pull && cd .. && cp -rfp ./Docs-Template-Repo-Preview/* ./DLRDoc/
-          cd DLRDoc && bundle exec jekyll build --incremental
+          [ -d DLRDocCore ] && rm -rf DLRDocCore
+          [ -d label-recognition-docs ] && rm -rf label-recognition-docs
+          [ -d Docs-Template-Repo-Preview ] && rm -rf Docs-Template-Repo-Preview
+          [ ! -d DLRDocCore ] && mkdir -p DLRDocCore
+          git clone --depth 1 https://github.com/dynamsoft-docs/label-recognition-docs.git label-recognition-docs
+          git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-Preview
+          cp -rfp ./label-recognition-docs/* ./DLRDocCore/
+          cp -rfp ./Docs-Template-Repo-Preview/* ./DLRDocCore/
+          cd DLRDocCore && bundle exec jekyll build --incremental
 
       - name: Sync files - Main Site
         uses: SamKirkland/FTP-Deploy-Action@4.3.0
@@ -43,8 +47,8 @@ jobs:
           username: ${{ secrets.FTP_DYNAMSOFT_LOCAL_USER }}
           password: ${{ secrets.FTP_DYNAMSOFT_LOCAL_PASSWORD }}
           port: 21 
-          local-dir: /home/ubuntu/DLRDoc/_site/
-          server-dir: /www.dynamsoft.com/label-recognition/docs/
+          local-dir: /home/ubuntu/DLRDocCore/_site/
+          server-dir: /www.dynamsoft.com/label-recognition/docs/core/
 
   Build-Preview:
     if: ${{ github.ref == 'refs/heads/preview' }}
@@ -54,17 +58,25 @@ jobs:
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       # Runs a set of commands using the runners shell
+      - name: clear space
+        run: |
+          cd /home/ubuntu 
+          [ -d DLRDocCorePreview ] && rm -rf DLRDocCorePreview
+          [ -d label-recognition-docs-core-preview ] && rm -rf label-recognition-docs-core-preview
+          [ -d Docs-Template-Repo-Preview ] && rm -rf Docs-Template-Repo-Preview
+          cd /home/ubuntu
+
       - name: Build the site
         run: |
           cd /home/ubuntu
-          [ ! -d DLRDocPreview ] && mkdir -p DLRDocPreview
-          [ ! -d label-recognition-docs-preview ] && git clone --depth 1 --branch preview https://github.com/Dynamsoft/label-recognition-docs.git label-recognition-docs-preview
-          [ ! -d Docs-Template-Repo-preview ] && git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-preview
-          cd label-recognition-docs-preview && git pull && cd .. && cp -rfp ./label-recognition-docs-preview/* ./DLRDocPreview/
-          cd Docs-Template-Repo-Preview && git pull && cd .. && cp -rfp ./Docs-Template-Repo-Preview/* ./DLRDocPreview/
+          [ ! -d DLRDocCorePreview ] && mkdir -p DLRDocCorePreview
+          git clone --depth 1 --branch preview https://github.com/Dynamsoft-Docs/label-recognition-docs.git label-recognition-docs-core-preview
+          git clone --depth 1 --branch preview https://github.com/dynamsoft-docs/Docs-Template-Repo.git Docs-Template-Repo-Preview
+          cp -rfp ./label-recognition-docs-core-preview/* ./DLRDocCorePreview/
+          cp -rfp ./Docs-Template-Repo-Preview/* ./DLRDocCorePreview/
           sed -i -e "1,3s/blob\/master$/blob\/preview/" \
-          -e "1,3s/blob\/main$/blob\/preview/" /home/ubuntu/DLRDocPreview/_config.yml
-          cd DLRDocPreview && bundle exec jekyll build
+          -e "1,3s/blob\/main$/blob\/preview/" /home/ubuntu/DLRDocCorePreview/_config.yml
+          cd DLRDocCorePreview && bundle exec jekyll build
 
       - name: Sync files
         uses: SamKirkland/FTP-Deploy-Action@4.3.0
@@ -73,5 +85,5 @@ jobs:
           username: ${{ secrets.FTP_TEST_SITE_USER }}
           password: ${{ secrets.FTP_TEST_SITE_PASSWORD }}
           port: 7500 
-          local-dir: /home/ubuntu/DLRDocPreview/_site/
-          server-dir: /www.dynamsoft.com/label-recognition/docs/         
+          local-dir: /home/ubuntu/DLRDocCorePreview/_site/
+          server-dir: /www.dynamsoft.com/label-recognition/docs/core/         

.github/workflows/main.yml

@@ -1 +1 @@
-# label-recognizer
+# label-recognizer-docs

README.md

@@ -1,61 +1,90 @@
 repositoryUrl: https://github.com/dynamsoft-docs/label-recognition-docs/blob/master
-repository: Dynamsoft/label-recognition-docs
-docFullPath: https://www.dynamsoft.com/label-recognition/docs
-firstLevelUrl: /label-recognition/docs
-docHomePage: /label-recognition/docs/introduction/
+repository: Dynamsoft-Docs/label-recognition-docs
+docFullPath: https://www.dynamsoft.com/label-recognition/docs/core
+firstLevelUrl: /label-recognition/docs/core
+docHomePage: /label-recognition/docs/core/introduction/
 
-introduction: /label-recognition/docs/introduction/
-parameters: /label-recognition/docs/parameters/
-enumerations: /label-recognition/docs/parameters/enum/
-parameters-reference: /label-recognition/docs/parameters/reference/
+introduction: /label-recognition/docs/core/introduction/
+parameters: /label-recognition/docs/core/parameters/
+enumerations: /label-recognition/docs/core/parameters/enum/
+parameters-reference: /label-recognition/docs/core/parameters/reference/
 
-programming: /label-recognition/docs/programming/
+dcv_parameters: /capture-vision/docs/core/parameters/
+dcv_parameters_reference: /capture-vision/docs/core/parameters/reference/
+#license: /capture-vision/docs/core/license/
 
-c-cplusplus: /label-recognition/docs/programming/c-cplusplus/
-c-cplusplus-api-reference: /label-recognition/docs/programming/c-cplusplus/api-reference/
+c-cplusplus: /label-recognition/docs/server/programming/c-cplusplus/
+c-cplusplus-api-reference: /label-recognition/docs/server/programming/c-cplusplus/api-reference/
 
-c-functions: /label-recognition/docs/programming/c-cplusplus/api-reference/c-functions/
-cpp-methods: /label-recognition/docs/programming/c-cplusplus/api-reference/c-label-recognition-class/
-c-cplusplus-structs: /label-recognition/docs/programming/c-cplusplus/api-reference/structs/
+c-functions: /label-recognition/docs/server/programming/c-cplusplus/api-reference/c-functions/
+cpp-methods: /label-recognition/docs/server/programming/c-cplusplus/api-reference/c-label-recognition-class/
+c-cplusplus-structs: /label-recognition/docs/server/programming/c-cplusplus/api-reference/structs/
 
-c-cplusplus-release-notes: /label-recognition/docs/programming/c-cplusplus/release-notes/
+c-cplusplus-release-notes: /label-recognition/docs/server/programming/c-cplusplus/release-notes/
 
-android: /label-recognition/docs/programming/android/
-android-api: /label-recognition/docs/programming/android/api-reference/
-android-release-notes: /label-recognition/docs/programming/android/release-notes/
+cpp: /label-recognition/docs/server/programming/cplusplus/
+cpp_api: /label-recognition/docs/server/programming/cplusplus/api-reference/
+cpp_release_notes: /label-recognition/docs/server/programming/cplusplus/release-notes/
 
-dotnet: /label-recognition/docs/programming/dotnet/
-dotnet_api: /label-recognition/docs/programming/dotnet/api-reference/
-dotnet_release_notes: /label-recognition/docs/programming/dotnet/release-notes/
+c: /label-recognition/docs/server/programming/c/
+c_api: /label-recognition/docs/server/programming/c/api-reference/
 
-objectivec-swift: /label-recognition/docs/programming/objectivec-swift/
-objectivec-swift-api: /label-recognition/docs/programming/objectivec-swift/api-reference/
-objectivec-swift-release-notes: /label-recognition/docs/programming/objectivec-swift/release-notes/
+android: /label-recognition/docs/mobile/programming/android/
+android-api: /label-recognition/docs/mobile/programming/android/api-reference/
+android-release-notes: /label-recognition/docs/mobile/programming/android/release-notes/
 
-java: /label-recognition/docs/programming/java/
-java-api: /label-recognition/docs/programming/java/api-reference/
-java-release-notes: /label-recognition/docs/programming/java/release-notes/
+dotnet: /label-recognition/docs/server/programming/dotnet/
+dotnet_api: /label-recognition/docs/server/programming/dotnet/api-reference/
+dotnet_release_notes: /label-recognition/docs/server/programming/dotnet/release-notes/
 
-javascript: /label-recognition/docs/programming/javascript/
-javascript-api: /label-recognition/docs/programming/javascript/api-reference/
-javascript-release-notes: /label-recognition/docs/programming/javascript/release-notes/
+objectivec-swift: /label-recognition/docs/mobile/programming/objectivec-swift/
+objectivec-swift-api: /label-recognition/docs/mobile/programming/objectivec-swift/api-reference/
+objectivec-swift-release-notes: /label-recognition/docs/mobile/programming/objectivec-swift/release-notes/
 
-assets: /label-recognition/docs/assets/
-edit_icon: /label-recognition/docs/assets/img-icon/edit-icon.png
-smile_icon: /label-recognition/docs/assets/img-icon/icon-smile.png
-sad_icon: /label-recognition/docs/assets/img-icon/icon-sad.png
-dbr_icon: /label-recognition/docs/assets/img-icon/icon-dbr.svg
-dwt_icon: /label-recognition/docs/assets/img-icon/icon-dwt.svg
-dnt_icon: /label-recognition/docs/assets/img-icon/icon-dnt.svg
+java: /label-recognition/docs/server/programming/java/
+java-api: /label-recognition/docs/server/programming/java/api-reference/
+java-release-notes: /label-recognition/docs/server/programming/java/release-notes/
 
-release-notes: /label-recognition/docs/release-notes/
-license-activation: /label-recognition/docs/license-activation/
+js: /label-recognition/docs/web/programming/javascript/
+js-api: /label-recognition/docs/web/programming/javascript/api-reference/
+js-release-notes: /label-recognition/docs/web/programming/javascript/release-notes/
+
+assets: /label-recognition/docs/core/assets/
+edit_icon: /label-recognition/docs/core/assets/img-icon/edit-icon.png
+smile_icon: /label-recognition/docs/core/assets/img-icon/icon-smile.png
+sad_icon: /label-recognition/docs/core/assets/img-icon/icon-sad.png
+dbr_icon: /label-recognition/docs/core/assets/img-icon/icon-dbr.svg
+dwt_icon: /label-recognition/docs/core/assets/img-icon/icon-dwt.svg
+dnt_icon: /label-recognition/docs/core/assets/img-icon/icon-dnt.svg
+
+release-notes: /label-recognition/docs/core/release-notes/
+license-activation: /label-recognition/docs/core/license-activation/
 
 useVersionTree: true
 
-baseurl: "/label-recognition/docs"
+baseurl: "/label-recognition/docs/core"
+
 plugins:
   - jemoji
-
-url: "https://www.dynamsoft.com" # sitemap root
-
+  - jekyll-sitemap
+
+
+defaults:
+  - scope:
+      path: ""
+    values:
+      layout: "default-layout"
+      noTitleIndex: true
+      needAutoGenerateSidebar: true
+      needGenerateH3Content: true
+  - scope: 
+      path: "" 
+    values: 
+      docRootName: "Label Recognizer" 
+      docHomePage: "/label-recognition/docs/core/introduction/"
+  - scope:
+      path: "Hide_Tree_Page.html"
+    values:
+      sitemap: false
+
+url: "https://www.dynamsoft.com" # sitemap root

_config.yml

@@ -5,25 +5,13 @@ tree_file_list:
     - sidelist-parameters/parameters-enumerations.html
     - sidelist-parameters/parameters-references-v1.2.1.html
     - sidelist-parameters/parameters-references.html
-    - sidelist-parameters.html
-    - sidelist-programming/programming-android-v1.2.1.html
-    - sidelist-programming/programming-android-v2.0.0.html
-    - sidelist-programming/programming-android.html
-    - sidelist-programming/programming-c-v1.2.1.html
-    - sidelist-programming/programming-c.html
-    - sidelist-programming/programming-cpp-v1.2.1.html
-    - sidelist-programming/programming-cpp-v2.2.10.html
-    - sidelist-programming/programming-cpp.html
-    - sidelist-programming/programming-dotnet-v1.2.1.html
-    - sidelist-programming/programming-dotnet.html
-    - sidelist-programming/programming-java-v1.2.1.html
-    - sidelist-programming/programming-java.html
-    - sidelist-programming/programming-objectivec-swift-v1.2.1.html
-    - sidelist-programming/programming-objectivec-swift.html
-    - sidelist-programming/programming-javascript-v2.2.10.html
-    - sidelist-programming/programming-javascript.html
-    - sidelist-programming-v1.2.1.html
-    - sidelist-programming.html
     - sidelist-release-notes.html
     - sidelist-license-activation.html
-
+    - sidelist-development-v1.2.1.html
+    - sidelist-development-v2.2.20.html
+    - sidelist-development.html
+    - sidelist-parameters-organization.html
+    - sidelist-parameters-reference.html
+    - sidelist-understanding.html
+    - sidelist-understanding-v2.2.20.html
+    - sidelist-useful.html