New larvitar docs and improvements (#407)

* init docs2

* feat: guide and init api

* fix: .gitignore for docs

* feat: initializing API

* feat: parsing

* feat: parsing and store

* fix: added loaders

* feat: updated docs and new manager

* fix: upgrade to docs vuepress

* fix: version

* fix: deploy

* fix: base url

* fix: install in wf

* fix: deps

* fix: CNAME path

* fix: added CNAME

* fix: copy examples in build

* fix: larvitar build for examples and dev

* fix: examples path

* fix: removed dist

* fix: workflows

* fix: added modules

* fix: added modules

* fix: added pr workflow

* fix: broken links

* fix: SeriesManager renamed to ImageManager

* fix: names

* fix: fileManager check

* fix: added deprecation warnings

* fix: typo

* fix: missing files

* fix: base example

* fix: readme version

* fix: 3.0.0-beta.1 version

Author: daron1337

.github/workflows/build-docs.yml

@@ -1,18 +1,16 @@
 name: CI-docs
 
 on:
-  pull_request:
-    types:
-      - opened
-      - reopened
-      - synchronize
+  push:
+    branches:
+      - master
 
 jobs:
   build:
     runs-on: ubuntu-latest
 
     steps:
-      # CLone repo at current branch
+      # Clone repo at current branch
       - name: Clone repo
         uses: actions/checkout@v4
         with:
@@ -29,31 +27,41 @@ jobs:
       # Install node modules
       - name: Install node modules
         run: |
-          yarn install
+          yarn install --frozen-lockfile
 
-      # Clone template
-      - name: Clone docdash template
-        uses: actions/checkout@v4
-        with:
-          repository: clenemt/docdash
-          path: ./template/docdash/
+      # Generate docs
+      - name: Generate docs
+        run: |
+          yarn run docs:build
 
-      # Install docdash node modules
-      - name: Install node modules
-        working-directory: ./template/docdash/
+      # Generate Build
+      - name: Generate build
         run: |
-          yarn install
+          yarn run build
 
-      # Generate docs
-      - name: Generate docs
+      # Copy larvitar.js
+      - name: Copy larvitar build for examples
+        run: |
+          cp dist/larvitar.js docs/.vuepress/dist/assets
+
+      # Copy CNAME
+      - name: Copy CNAME
+        run: |
+          cp docs/CNAME docs/.vuepress/dist
+
+      # Copy Examples
+      - name: Copy Examples
         run: |
-          yarn generate-docs
+          cp -R docs/examples docs/.vuepress/dist
 
-      # Commit docs on current branch (update pull request)
-      - name: Commit docs
-        uses: actions-js/push@master
+      # Deploy to GitHub Pages
+      - name: Deploy to GitHub Pages
+        uses: crazy-max/ghaction-github-pages@v4
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          message: "Update docs"
-          branch: ${{ github.head_ref }}
-          empty: true
+          # deploy to gh-pages branch
+          target_branch: gh-pages
+          # deploy the default output dir of VuePress
+          build_dir: docs/.vuepress/dist
+        env:
+          # @see https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret
+          GITHUB_TOKEN: ${{ secrets.GIT_TOKEN }}

.github/workflows/deploy.yml

@@ -17,13 +17,25 @@ jobs:
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GIT_TOKEN }}
 
       # Setup node environment
       - name: Setup Node.js environment
         uses: actions/setup-node@v4
         with:
           node-version: "20"
 
+      # Install node modules
+      - name: Install node modules
+        run: |
+          yarn install --frozen-lockfile
+
+      # Generate Build
+      - name: Generate build
+        run: |
+          yarn run build
+
       # Clean examples and docs file
       - name: Clean examples and docs file
         run: |

.github/workflows/pr.yml

@@ -0,0 +1,42 @@
+name: CI-PR
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GIT_TOKEN }}
+
+      # Setup node environment
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      # Install node modules
+      - name: Install node modules
+        run: |
+          yarn install --frozen-lockfile
+
+      # Generate docs
+      - name: Generate docs
+        run: |
+          yarn run docs:build
+
+      # Generate Build
+      - name: Generate build
+        run: |
+          yarn run build

.gitignore

@@ -18,8 +18,14 @@ yarn-error.log*
 *.sln
 *.sw?
 
-# JsDocs templates directory
-template/docdash/
-
 # TS coverage reports
 /coverage-ts
+
+# docs
+docs/.vuepress/.cache/
+docs/.vuepress/.temp/
+docs/.vuepress/dist/
+docs_legacy/*
+
+# build files
+dist/*

README.md

@@ -8,7 +8,7 @@
 
 ## Dicom Image Toolkit for CornerstoneJS
 
-### Current version: 2.7.3
+### Current version: 3.0.0-beta.1
 
 ### Latest Published Release: 2.7.3