feat: Add docs with example

.eslintrc

@@ -61,7 +61,7 @@
     "unicorn/prefer-string-starts-ends-with": "warn",
     "unicorn/prefer-string-trim-start-end": "warn",
     "unicorn/prefer-switch": "warn",
-    "unicorn/prefer-top-level-await": "warn",
+    "unicorn/prefer-top-level-await": "off",
     "unicorn/prefer-type-error": "warn",
     "unicorn/relative-url-style": "warn",
     "unicorn/require-array-join-separator": "warn",

docs/example.ts

@@ -0,0 +1,16 @@
+import {createClient} from '@opensdks/core'
+import type {githubTypes} from '@opensdks/sdk-github'
+
+const github = createClient<githubTypes['paths']>({
+  baseUrl: 'https://api.github.com',
+  headers: {
+    authorization: `Bearer ${process.env['GITHUB_TOKEN']}`,
+    'X-GitHub-Api-Version': '2022-11-28',
+  },
+})
+
+void github
+  .GET('/orgs/{org}/actions/secrets', {params: {path: {org: 'usevenice'}}})
+  .then((r) => {
+    console.log(r.data)
+  })

docs/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@opensdks/docs",
+  "dependencies": {
+    "@opensdks/core": "workspace:*",
+    "@opensdks/sdk-discord": "workspace*",
+    "@opensdks/sdk-github": "workspace*",
+    "@opensdks/sdk-openai": "workspace*",
+    "@opensdks/sdk-plaid": "workspace*",
+    "@opensdks/sdk-slack": "workspace*",
+    "@opensdks/sdk-venice": "workspace*"
+  }
+}

docs/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./dist"
+  },
+  "include": ["./*.ts"]
+}

pnpm-workspace.yaml

@@ -2,3 +2,4 @@ packages:
   - 'packages/*'
   - 'packages/sdks/*'
   - 'packages/utils/*'
+  - 'docs'

tsconfig.base.json

@@ -1,6 +1,5 @@
 // TODO: Get all the tsconfigs to extend this one
 // in particular the root /tsconfig.json and /apps/web/tsconfig.json
-
 {
   "extends": "@tsconfig/strictest/tsconfig.json",
   "compilerOptions": {
@@ -24,10 +23,9 @@
     // for the foreseeable future
     // @see https://github.com/egoist/tsup/issues/885
     "declarationMap": true,
-    // This is a hack because otherwise when running code that imports from the
-    // web module we get package not found issues. (such as `generate` call in the sdk)
     "paths": {
-      "@/*": ["./apps/web/*"]
+      "@opensdks/core": ["./packages/core/src"],
+      "@opensdks/core/*": ["./packages/core/src/*"]
     }
   },
   "exclude": ["node_modules"]