RSDK-2656 update docs (#60)

Author: maximpertsov

.github/workflows/docs.yml

@@ -30,13 +30,13 @@ jobs:
         uses: actions/upload-artifact@v3
         with:
           name: html-docs
-          path: docs
+          path: docs/dist
 
       - name: Deploy docs
         uses: peaceiris/actions-gh-pages@v3
         if: github.ref == 'refs/heads/main'
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs
+          publish_dir: docs/dist
           publish_branch: docs-gh_pages
           cname: ts.viam.dev

.gitignore

@@ -110,4 +110,4 @@ src/gen/
 bin/
 
 # typedoc documentation
-docs
+docs/dist

README.md

@@ -1,5 +1,9 @@
 # Viam TypeScript SDK
 
+[![license](https://img.shields.io/badge/license-Apache_2.0-blue)](https://github.com/viamrobotics/viam-typescript-sdk/blob/main/LICENSE)
+[![npm](https://img.shields.io/npm/v/@viamrobotics/sdk?color=33cd56&logo=npm)](https://www.npmjs.com/package/@viamrobotics/sdk)
+[![documentation](https://img.shields.io/static/v1?label=docs&message=ts.viam.dev&color=lightgray)](https://ts.viam.dev)
+
 ## (In)stability Notice
 
 > **Warning**

docs.css renamed to docs/docs.css

@@ -1,3 +1,6 @@
+.tsd-page-title {
+  display: none;
+}
 .deprecated {
   text-decoration: none;
 }

examples/teleop/package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@viamrobotics/sdk-teleop-demo",
   "version": "0.0.1",
-  "description": "Viam SDK tele-operation demo",
+  "description": "Viam SDK tele-operation demo in Elm",
   "scripts": {
     "start": "vite --port 8000",
     "test": "echo \"Error: no test specified\" && exit 1"
@@ -10,7 +10,7 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@improbable-eng/grpc-web": "^0.15.0",
-    "@viamrobotics/sdk": "^0.0.27"
+    "@viamrobotics/sdk": "file:../.."
   },
   "devDependencies": {
     "elm": "^0.19.1-5",

examples/teleop/package.json

@@ -3,7 +3,7 @@
   "version": "0.0.1",
   "description": "Viam SDK Quickstart",
   "scripts": {
-    "watch": "esbuild ./src/main.ts --bundle --outfile=static/main.js --servedir=static",
+    "start": "esbuild ./src/main.ts --bundle --outfile=static/main.js --servedir=static",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "",
@@ -12,6 +12,6 @@
     "esbuild": "0.16.12"
   },
   "dependencies": {
-    "@viamrobotics/sdk": "^0.0.34"
+    "@viamrobotics/sdk": "file:../.."
   }
 }

examples/vanilla/package-lock.json

@@ -68,7 +68,7 @@
     "prettier": "^2.8.1",
     "prettier-plugin-jsdoc": "^0.4.2",
     "ts-protoc-gen": "^0.15.0",
-    "typedoc": "^0.23.28",
+    "typedoc": "^0.24.1",
     "typescript": "^5.0.3",
     "vite": "^4.2.1",
     "vitest": "^0.28.4"

examples/vanilla/package.json

@@ -12,6 +12,7 @@ export const version = __VERSION__;
 export { default as robotApi } from './gen/robot/v1/robot_pb';
 export {
   type Robot,
+  type DialConf,
   type DialDirectConf,
   type DialWebRTCConf,
   RobotClient,