Skip to content

Commit 3683f0a

Browse files
kinyoklionkinyoklion
authored
chore: Add issue templates and readme updates for browser and server-ai. (#666)
1 parent d95cd87 commit 3683f0a

File tree

8 files changed

+145
-10
lines changed

8 files changed

+145
-10
lines changed

‎.github/ISSUE_TEMPLATE/package-sdk-browser--bug_report.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: '@launchdarkly/js-client-sdk Bug Report'
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'package: sdk/browser, bug'
6+
assignees: ''
7+
---
8+
9+
**Is this a support request?**
10+
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 [email protected].
11+
12+
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.
13+
14+
**Describe the bug**
15+
A clear and concise description of what the bug is.
16+
17+
**To reproduce**
18+
Steps to reproduce the behavior.
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Logs**
24+
If applicable, add any log output related to your problem.
25+
26+
**SDK version**
27+
The version of this SDK that you are using.
28+
29+
**Language version, developer tools**
30+
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.
31+
32+
**OS/platform**
33+
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.
34+
35+
**Additional context**
36+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/package-sdk-browser--feature_request.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: '@launchdarkly/js-client-sdk Feature Request'
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'package: sdk/browser, feature'
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I would love to see the SDK [...does something new...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context about the feature request here.

‎.github/ISSUE_TEMPLATE/package-sdk-server-ai--bug_report.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: '@launchdarkly/server-sdk-ai Bug Report'
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'package: sdk/server-ai, bug'
6+
assignees: ''
7+
---
8+
9+
**Is this a support request?**
10+
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 [email protected].
11+
12+
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.
13+
14+
**Describe the bug**
15+
A clear and concise description of what the bug is.
16+
17+
**To reproduce**
18+
Steps to reproduce the behavior.
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Logs**
24+
If applicable, add any log output related to your problem.
25+
26+
**SDK version**
27+
The version of this SDK that you are using.
28+
29+
**Language version, developer tools**
30+
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.
31+
32+
**OS/platform**
33+
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.
34+
35+
**Additional context**
36+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/package-sdk-server-ai--feature_request.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: '@launchdarkly/server-sdk-ai Feature Request'
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: 'package: sdk/sdk-ai, feature'
6+
assignees: ''
7+
---
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Ex. I would love to see the SDK [...does something new...]
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen.
14+
15+
**Describe alternatives you've considered**
16+
A clear and concise description of any alternative solutions or features you've considered.
17+
18+
**Additional context**
19+
Add any other context about the feature request here.

‎README.md‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,8 @@ This includes shared libraries, used by SDKs and other tools, as well as SDKs.
1313
| [@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] |
1414
| [@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] |
1515
| [@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] |
16-
17-
<!--
18-
TODO: Add row once @launchdarkly/js-client-sdk has been published.
1916
| [@launchdarkly/js-client-sdk](packages/sdk/browser/README.md) | [![NPM][sdk-browser-npm-badge]][sdk-browser-npm-link] | [Browser][package-sdk-browser-issues] | [![Actions Status][sdk-browser-ci-badge]][sdk-browser-ci] |
20-
-->
17+
| [@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] |
2118

2219
| Shared packages | npm | issues | tests |
2320
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------- |
@@ -184,3 +181,13 @@ We encourage pull requests and other contributions from the community. Check out
184181
[sdk-browser-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/js-client-sdk.svg?style=flat-square
185182
[sdk-browser-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/js-client-sdk.svg?style=flat-square
186183
[package-sdk-browser-issues]: https://github.com/launchdarkly/js-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+sdk%2Fbrowser%22+
184+
[//]: # 'sdk/server-ai'
185+
[sdk-server-ai-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/server-ai.yml/badge.svg
186+
[sdk-server-ai-ci]: https://github.com/launchdarkly/js-core/actions/workflows/server-ai.yml
187+
[sdk-server-ai-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/server-sdk-ai.svg?style=flat-square
188+
[sdk-server-ai-npm-link]: https://www.npmjs.com/package/@launchdarkly/server-sdk-ai
189+
[sdk-server-ai-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
190+
[sdk-server-ai-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/server-ai/docs/
191+
[sdk-server-ai-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/server-sdk-ai.svg?style=flat-square
192+
[sdk-server-ai-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/server-sdk-ai.svg?style=flat-square
193+
[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+

‎packages/sdk/browser/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# LaunchDarkly JavaScript SDK for Browsers
22

3-
<!--
3+
44
[![NPM][browser-sdk-npm-badge]][browser-sdk-npm-link]
55
[![Actions Status][browser-sdk-ci-badge]][browser-sdk-ci]
66
[![Documentation][browser-sdk-ghp-badge]][browser-sdk-ghp-link]
77
[![NPM][browser-sdk-dm-badge]][browser-sdk-npm-link]
88
[![NPM][browser-sdk-dt-badge]][browser-sdk-npm-link]
9-
-->
9+
1010

1111
# ⛔️⛔️⛔️⛔️
1212

‎packages/sdk/server-ai/README.md‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# LaunchDarkly AI SDK for Server-Side JavaScript
22

3+
[![NPM][server-ai-sdk-npm-badge]][server-ai-sdk-npm-link]
4+
[![Actions Status][server-ai-sdk-ci-badge]][server-ai-sdk-ci]
5+
[![Documentation][server-ai-sdk-ghp-badge]][server-ai-sdk-ghp-link]
6+
[![NPM][server-ai-sdk-dm-badge]][server-ai-sdk-npm-link]
7+
[![NPM][server-ai-sdk-dt-badge]][server-ai-sdk-npm-link]
8+
39
# ⛔️⛔️⛔️⛔️
410

511
> [!CAUTION]
@@ -62,7 +68,11 @@ We encourage pull requests and other contributions from the community. Check out
6268
- [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation
6369
- [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates
6470

65-
[node-otel-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/node-otel.yml/badge.svg
66-
[node-otel-ci]: https://github.com/launchdarkly/js-core/actions/workflows/node-otel.yml
67-
[node-otel-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/node-server-sdk-otel.svg?style=flat-square
68-
[node-otel-npm-link]: https://www.npmjs.com/package/@launchdarkly/node-server-sdk-otel
71+
[server-ai-sdk-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/server-ai.yml/badge.svg
72+
[server-ai-sdk-ci]: https://github.com/launchdarkly/js-core/actions/workflows/server-ai.yml
73+
[server-ai-sdk-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/server-sdk-ai.svg?style=flat-square
74+
[server-ai-sdk-npm-link]: https://www.npmjs.com/package/@launchdarkly/server-sdk-ai
75+
[server-ai-sdk-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
76+
[server-ai-sdk-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/server-ai/docs/
77+
[server-ai-sdk-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/server-sdk-ai.svg?style=flat-square
78+
[server-ai-sdk-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/server-sdk-ai.svg?style=flat-square

‎packages/sdk/server-ai/src/index.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
/**
2+
* This is the API reference for the LaunchDarkly AI SDK for Server-Side JavaScript.
3+
*
4+
* In typical usage, you will call {@link initAi} once at startup time to obtain an instance of
5+
* {@link LDAIClient}, which provides access to all of the SDK's functionality.
6+
*
7+
* @packageDocumentation
8+
*/
19
import { LDAIClient } from './api/LDAIClient';
210
import { LDAIClientImpl } from './LDAIClientImpl';
311
import { LDClientMin } from './LDClientMin';

0 commit comments

Comments
 (0)