feat: docs sdk page #386
feat: docs sdk page #386
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
There was a problem hiding this comment.
Pull Request Overview
This PR introduces documentation for the SDK page and updates the TypeScript example SDK along with its configuration, scripts, and authentication flows. Key changes include updating the tsconfig include pattern, adding a new "auth" script in package.json, revising resource management logic in index.ts and auth.ts, and adding new documentation pages and configuration.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| examples/sdk-typescript/tsconfig.json | Updated the include pattern from "index.ts" to "*.ts" for broader matching. |
| examples/sdk-typescript/package.json | Added a new "auth" script alongside the existing "start" script. |
| examples/sdk-typescript/index.ts | Revised the resource management logic and simplified environment variable checks. |
| examples/sdk-typescript/auth.ts | Added a new authentication flow example, similar to index.ts but with slight differences. |
| docs/zudoku.config.ts | Added a new navigation entry for the SDKs documentation. |
| docs/pages/sdks.mdx | Created a new MDX documentation page that provides an overview and usage example for the SDKs. |
Comments suppressed due to low confidence (2)
examples/sdk-typescript/auth.ts:8
- [nitpick] Consider harmonizing the approach to environment variables between auth.ts and index.ts (using a consistent tenant identifier and SERVER_URL variable naming) to reduce potential confusion.
const TENANT_ID = process.env.TENANT_ID;
examples/sdk-typescript/index.ts:21
- [nitpick] The tenantId is hardcoded in index.ts while auth.ts retrieves TENANT_ID from the environment; consider aligning the approach for consistency across the examples.
const tenantId = `hookdeck`;
| @@ -7,5 +7,5 @@ | |||
| "strict": true, | |||
| "skipLibCheck": true | |||
| }, | |||
| "include": ["index.ts"] | |||
| "include": ["*.ts"], | |||
There was a problem hiding this comment.
Ensure that the new include pattern ('*.ts') in tsconfig.json covers the intended files and does not unintentionally include test or support files.
| "include": ["*.ts"], | |
| "include": ["src/**/*.ts"], | |
| "exclude": ["**/*.test.ts", "**/*.d.ts"], |
Copilot uses AI. Check for mistakes.
No description provided.