Merge pull request #49 from aws4embeddedlinux/doc-test

add publish to github pages for api doc

.github/workflows/doc.yml

@@ -0,0 +1,25 @@
+name: Typedoc build and deploy doc to GH pages
+on:
+    push:
+        branches: ["doc"]
+
+    workflow_dispatch:
+
+permissions:
+    contents: write
+jobs:
+    build-and-deploy:
+        runs-on: ubuntu-latest
+        steps:
+        - name: Checkout
+          uses: actions/checkout@v3
+
+        - name: Install and Build
+          run: |
+            npm ci
+            npm run doc
+
+        - name: Deploy
+          uses: JamesIves/github-pages-deploy-action@v4
+          with:
+            folder: dist/docs

README.md

@@ -8,6 +8,9 @@ This [cdk](https://github.com/aws/aws-cdk) IaC library help you to deploy AWS cl
 ### Quickstart
 Use the [examples](https://github.com/aws4embeddedlinux/aws4embeddedlinux-ci-examples) in our examples repo.
 
+### API documentation
+[API documentation](https://aws4embeddedlinux.github.io/aws4embeddedlinux-ci/) generated by `npm run doc`
+
 ### Development Setup
 You can use [`npm link`](https://docs.npmjs.com/cli/v10/commands/npm-link) to develop with a local copy of this repo.