From fc63eec0888c65323f584db5ba03cdf65460ff4f Mon Sep 17 00:00:00 2001 From: Ryan Lamb <4955475+kinyoklion@users.noreply.github.com> Date: Wed, 6 Nov 2024 09:33:33 -0800 Subject: [PATCH 1/2] chore: Add issue templates and readme updates for browser and server-ai. --- .../package-sdk-browser--bug_report.md | 36 +++++++++++++++++++ .../package-sdk-browser--feature_request.md | 19 ++++++++++ .../package-sdk-server-ai--bug_report.md | 36 +++++++++++++++++++ .../package-sdk-server-ai--feature_request.md | 19 ++++++++++ README.md | 15 +++++--- packages/sdk/browser/README.md | 4 +-- packages/sdk/server-ai/README.md | 18 +++++++--- 7 files changed, 137 insertions(+), 10 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/package-sdk-browser--bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/package-sdk-browser--feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/package-sdk-server-ai--bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/package-sdk-server-ai--feature_request.md diff --git a/.github/ISSUE_TEMPLATE/package-sdk-browser--bug_report.md b/.github/ISSUE_TEMPLATE/package-sdk-browser--bug_report.md new file mode 100644 index 000000000..5941414a2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/package-sdk-browser--bug_report.md @@ -0,0 +1,36 @@ +--- +name: '@launchdarkly/js-client-sdk Bug Report' +about: Create a report to help us improve +title: '' +labels: 'package: sdk/browser, bug' +assignees: '' +--- + +**Is this a support request?** +This issue tracker is maintained by LaunchDarkly SDK developers and is intended for feedback on the code in this library. If you're not sure whether the problem you are having is specifically related to this library, or to the LaunchDarkly service overall, it may be more appropriate to contact the LaunchDarkly support team; they can help to investigate the problem and will consult the SDK team if necessary. You can submit a support request by going [here](https://support.launchdarkly.com/) and clicking "submit a request", or by emailing support@launchdarkly.com. + +Note that issues filed on this issue tracker are publicly accessible. Do not provide any private account information on your issues. If your problem is specific to your account, you should submit a support request as described above. + +**Describe the bug** +A clear and concise description of what the bug is. + +**To reproduce** +Steps to reproduce the behavior. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Logs** +If applicable, add any log output related to your problem. + +**SDK version** +The version of this SDK that you are using. + +**Language version, developer tools** +For instance, Go 1.11 or Ruby 2.5.3. If you are using a language that requires a separate compiler, such as C, please include the name and version of the compiler too. + +**OS/platform** +For instance, Ubuntu 16.04, Windows 10, or Android 4.0.3. If your code is running in a browser, please also include the browser type and version. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/package-sdk-browser--feature_request.md b/.github/ISSUE_TEMPLATE/package-sdk-browser--feature_request.md new file mode 100644 index 000000000..97ed9ca69 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/package-sdk-browser--feature_request.md @@ -0,0 +1,19 @@ +--- +name: '@launchdarkly/js-client-sdk Feature Request' +about: Create a report to help us improve +title: '' +labels: 'package: sdk/browser, feature' +assignees: '' +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I would love to see the SDK [...does something new...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/package-sdk-server-ai--bug_report.md b/.github/ISSUE_TEMPLATE/package-sdk-server-ai--bug_report.md new file mode 100644 index 000000000..f1cdeee72 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/package-sdk-server-ai--bug_report.md @@ -0,0 +1,36 @@ +--- +name: '@launchdarkly/server-sdk-ai Bug Report' +about: Create a report to help us improve +title: '' +labels: 'package: sdk/server-ai, bug' +assignees: '' +--- + +**Is this a support request?** +This issue tracker is maintained by LaunchDarkly SDK developers and is intended for feedback on the code in this library. If you're not sure whether the problem you are having is specifically related to this library, or to the LaunchDarkly service overall, it may be more appropriate to contact the LaunchDarkly support team; they can help to investigate the problem and will consult the SDK team if necessary. You can submit a support request by going [here](https://support.launchdarkly.com/) and clicking "submit a request", or by emailing support@launchdarkly.com. + +Note that issues filed on this issue tracker are publicly accessible. Do not provide any private account information on your issues. If your problem is specific to your account, you should submit a support request as described above. + +**Describe the bug** +A clear and concise description of what the bug is. + +**To reproduce** +Steps to reproduce the behavior. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Logs** +If applicable, add any log output related to your problem. + +**SDK version** +The version of this SDK that you are using. + +**Language version, developer tools** +For instance, Go 1.11 or Ruby 2.5.3. If you are using a language that requires a separate compiler, such as C, please include the name and version of the compiler too. + +**OS/platform** +For instance, Ubuntu 16.04, Windows 10, or Android 4.0.3. If your code is running in a browser, please also include the browser type and version. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/package-sdk-server-ai--feature_request.md b/.github/ISSUE_TEMPLATE/package-sdk-server-ai--feature_request.md new file mode 100644 index 000000000..b99df9e5c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/package-sdk-server-ai--feature_request.md @@ -0,0 +1,19 @@ +--- +name: '@launchdarkly/server-sdk-ai Feature Request' +about: Create a report to help us improve +title: '' +labels: 'package: sdk/sdk-ai, feature' +assignees: '' +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I would love to see the SDK [...does something new...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context about the feature request here. diff --git a/README.md b/README.md index fd6ef6088..441ba6ff9 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,8 @@ This includes shared libraries, used by SDKs and other tools, as well as SDKs. | [@launchdarkly/node-server-sdk](packages/sdk/server-node/README.md) | [![NPM][sdk-server-node-npm-badge]][sdk-server-node-npm-link] | [Node.js Server][package-sdk-server-node-issues] | [![Actions Status][sdk-server-node-ci-badge]][sdk-server-node-ci] | | [@launchdarkly/vercel-server-sdk](packages/sdk/vercel/README.md) | [![NPM][sdk-vercel-npm-badge]][sdk-vercel-npm-link] | [Vercel][package-sdk-vercel-issues] | [![Actions Status][sdk-vercel-ci-badge]][sdk-vercel-ci] | | [@launchdarkly/react-native-client-sdk](packages/sdk/react-native/README.md) | [![NPM][sdk-react-native-npm-badge]][sdk-react-native-npm-link] | [React-Native][package-sdk-react-native-issues] | [![Actions Status][sdk-react-native-ci-badge]][sdk-react-native-ci] | - - +| [@launchdarkly/server-sdk-ai](packages/sdk/server-ai/README.md) | [![NPM][sdk-server-ai-npm-badge]][sdk-server-ai-npm-link] | [server-ai][package-sdk-server-ai-issues] | [![Actions Status][sdk-server-ai-ci-badge]][sdk-server-ai-ci] | | Shared packages | npm | issues | tests | | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------- | @@ -184,3 +181,13 @@ We encourage pull requests and other contributions from the community. Check out [sdk-browser-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/js-client-sdk.svg?style=flat-square [sdk-browser-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/js-client-sdk.svg?style=flat-square [package-sdk-browser-issues]: https://github.com/launchdarkly/js-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fbrowser%22+ +[//]: # 'sdk/server-ai' +[sdk-server-ai-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/server-ai.yml/badge.svg +[sdk-server-ai-ci]: https://github.com/launchdarkly/js-core/actions/workflows/server-ai.yml +[sdk-server-ai-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/server-sdk-ai.svg?style=flat-square +[sdk-server-ai-npm-link]: https://www.npmjs.com/package/@launchdarkly/server-sdk-ai +[sdk-server-ai-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8 +[sdk-server-ai-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/server-ai/docs/ +[sdk-server-ai-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/server-sdk-ai.svg?style=flat-square +[sdk-server-ai-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/server-sdk-ai.svg?style=flat-square +[package-sdk-server-ai-issues]: https://github.com/launchdarkly/js-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fserver-ai%22+ diff --git a/packages/sdk/browser/README.md b/packages/sdk/browser/README.md index 6202f2b1e..b31b0a300 100644 --- a/packages/sdk/browser/README.md +++ b/packages/sdk/browser/README.md @@ -1,12 +1,12 @@ # LaunchDarkly JavaScript SDK for Browsers - + # ⛔️⛔️⛔️⛔️ diff --git a/packages/sdk/server-ai/README.md b/packages/sdk/server-ai/README.md index e4ae013f1..40ee29090 100644 --- a/packages/sdk/server-ai/README.md +++ b/packages/sdk/server-ai/README.md @@ -1,5 +1,11 @@ # LaunchDarkly AI SDK for Server-Side JavaScript +[![NPM][server-ai-sdk-npm-badge]][server-ai-sdk-npm-link] +[![Actions Status][server-ai-sdk-ci-badge]][server-ai-sdk-ci] +[![Documentation][server-ai-sdk-ghp-badge]][server-ai-sdk-ghp-link] +[![NPM][server-ai-sdk-dm-badge]][server-ai-sdk-npm-link] +[![NPM][server-ai-sdk-dt-badge]][server-ai-sdk-npm-link] + # ⛔️⛔️⛔️⛔️ > [!CAUTION] @@ -62,7 +68,11 @@ We encourage pull requests and other contributions from the community. Check out - [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation - [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates -[node-otel-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/node-otel.yml/badge.svg -[node-otel-ci]: https://github.com/launchdarkly/js-core/actions/workflows/node-otel.yml -[node-otel-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/node-server-sdk-otel.svg?style=flat-square -[node-otel-npm-link]: https://www.npmjs.com/package/@launchdarkly/node-server-sdk-otel +[server-ai-sdk-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/server-ai.yml/badge.svg +[server-ai-sdk-ci]: https://github.com/launchdarkly/js-core/actions/workflows/server-ai.yml +[server-ai-sdk-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/server-sdk-ai.svg?style=flat-square +[server-ai-sdk-npm-link]: https://www.npmjs.com/package/@launchdarkly/server-sdk-ai +[server-ai-sdk-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8 +[server-ai-sdk-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/server-ai/docs/ +[server-ai-sdk-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/server-sdk-ai.svg?style=flat-square +[server-ai-sdk-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/server-sdk-ai.svg?style=flat-square From aa6cb18470a0198b66d0e4605bd8ea37f28541ca Mon Sep 17 00:00:00 2001 From: Ryan Lamb <4955475+kinyoklion@users.noreply.github.com> Date: Wed, 6 Nov 2024 10:33:39 -0800 Subject: [PATCH 2/2] Add package documentation for server AI. --- packages/sdk/server-ai/src/index.ts | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/packages/sdk/server-ai/src/index.ts b/packages/sdk/server-ai/src/index.ts index 3f762c5fd..2ca8209b5 100644 --- a/packages/sdk/server-ai/src/index.ts +++ b/packages/sdk/server-ai/src/index.ts @@ -1,3 +1,11 @@ +/** + * This is the API reference for the LaunchDarkly AI SDK for Server-Side JavaScript. + * + * In typical usage, you will call {@link initAi} once at startup time to obtain an instance of + * {@link LDAIClient}, which provides access to all of the SDK's functionality. + * + * @packageDocumentation + */ import { LDAIClient } from './api/LDAIClient'; import { LDAIClientImpl } from './LDAIClientImpl'; import { LDClientMin } from './LDClientMin';