docs: add documentation system and more docs (#890)

* chore: add typedoc to build documentation

* docs: add more docs

* chore: add docs workflow

* refactor: small improvements

* refactor: improve typings system

* refactor: small types simplification

* build: re-enable skipLibCheck in tsconfig.json

---------

Co-authored-by: Anton Platonov <[email protected]>

Author: Lodin

.eslintrc.json

@@ -11,6 +11,7 @@
   },
   "plugins": ["tsdoc"],
   "rules": {
+    "@typescript-eslint/no-restricted-types": "off",
     "@typescript-eslint/no-invalid-void-type": "off",
     "@typescript-eslint/no-useless-template-literals": "off",
     "import/no-unassigned-import": "off",

.github/workflows/docs.yml

@@ -0,0 +1,42 @@
+name: Publish Docs
+
+on:
+  push:
+    branches: ['main']
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Use NodeJS LTS
+        uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+      - name: Install
+        run: npm ci
+      - name: Build Docs
+        run: npm run docs
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './.docs'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -6,3 +6,4 @@ coverage
 
 .idea
 .vscode
+.docs