Merge pull request #35 from pflooky/dev-mkdocs

Dev mkdocs

Author: jgperrin

.github/workflows/docs-site-deploy.yaml

@@ -0,0 +1,31 @@
+name: docs-site-deploy
+on:
+  push:
+    tags:
+      - "v*"
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-open-in-new-tab mike
+      - run: pip install mkdocs-material
+      - run: mike deploy --push --update-aliases ${{ github.ref_name }} latest

.idea/.gitignore

@@ -7,8 +7,9 @@ This document tracks the history and evolution of the **Open Data Contract Stand
 * Change `price.priceAmount` data type from `string` to `number`
 * Change `slaProperties.value` data type from `string` to `oneOf[string, number]`
 * Change `slaProperties.valueExt` data type from `string` to `oneOf[string, number]`
-* Update [examples](examples) to adhere to JSON schema
-* Full example from README directs to [full-example.yaml](examples/all/full-example.yaml)
+* Update [examples](docs/examples) to adhere to JSON schema
+* Full example from README directs to [full-example.yaml](docs/examples/all/full-example.yaml)
+* Add in mkdocs for creating documentation website
 
 # v2.2.1 - 2023-12-18 - APPROVED