docs(sdk): add community TypeScript SDK page - #493
Conversation
| ✨ Key Features | ||
|
|
||
| - **Built-in HTTP client**: Ready to use out of the box, no need to implement your own transport. |
There was a problem hiding this comment.
The
✨ Key Features line is plain text rather than a Markdown heading, so Docusaurus will not include it in the auto-generated table of contents and it won't carry an anchor. All other top-level sections in this file (Installation, Quick Start, Usage, etc.) use ## headings consistently.
| ✨ Key Features | |
| - **Built-in HTTP client**: Ready to use out of the box, no need to implement your own transport. | |
| ## ✨ Key Features | |
| - **Built-in HTTP client**: Ready to use out of the box, no need to implement your own transport. |
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
| const user = await client.users.create({ | ||
| username: 'newuser', | ||
| email: 'user@example.com' | ||
| // ... other fields | ||
| }) |
There was a problem hiding this comment.
The last shown property (
email) is missing a trailing comma before the // ... other fields comment. Readers who follow the hint and add a field directly below the comment will produce a syntax error because the preceding line has no comma. Adding the trailing comma now makes the example copy-paste safe.
| const user = await client.users.create({ | |
| username: 'newuser', | |
| email: 'user@example.com' | |
| // ... other fields | |
| }) | |
| const user = await client.users.create({ | |
| username: 'newuser', | |
| email: 'user@example.com', | |
| // ... other fields | |
| }) |
| const node = await client.nodes.create({ | ||
| name: 'Node 1', | ||
| host: 'node.example.com', | ||
| port: 443 | ||
| // ... other fields | ||
| }) |
There was a problem hiding this comment.
Same trailing-comma issue in the Nodes example —
port: 443 is missing a comma before the // ... other fields comment, so copy-pasting and extending the object will fail immediately.
| const node = await client.nodes.create({ | |
| name: 'Node 1', | |
| host: 'node.example.com', | |
| port: 443 | |
| // ... other fields | |
| }) | |
| const node = await client.nodes.create({ | |
| name: 'Node 1', | |
| host: 'node.example.com', | |
| port: 443, | |
| // ... other fields | |
| }) |
Adds a documentation page for the community-maintained TypeScript SDK (
@mishkat/remnawave-sdk) under the SDKs section, following the existing community SDK page format.