Skip to content

Commit 765b492

Browse files
adams85adams85
committed
wip
1 parent 6017600 commit 765b492

File tree

15 files changed

+168
-105
lines changed

15 files changed

+168
-105
lines changed

‎website/docs/sdk-reference/dotnet.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ else
6969
}
7070
```
7171

72+
The _ConfigCat SDK_ also offers a synchronous API for feature flag evaluation. Read more [here](#snapshots-and-non-blocking-synchronous-feature-flag-evaluation).
73+
7274
### 5. Dispose the _ConfigCat_ client
7375

7476
You can safely dispose all clients at once or individually and release all associated resources on application exit.

‎website/docs/sdk-reference/ios.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,8 @@ if isMyAwesomeFeatureEnabled {
145145
</TabItem>
146146
</Tabs>
147147
148+
The _ConfigCat SDK_ also offers a synchronous API for feature flag evaluation. Read more [here](#snapshots-and-non-blocking-synchronous-feature-flag-evaluation).
149+
148150
### 5. Close ConfigCat client​
149151
150152
You can safely shut down all clients at once or individually and release all associated resources on application exit.

‎website/docs/sdk-reference/js-ssr.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,17 @@ export const JavaScriptSSRSchema = require('@site/src/schema-markup/sdk-referenc
1616
[![codecov](https://codecov.io/gh/configcat/js-ssr-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/configcat/js-ssr-sdk)
1717
[![Known Vulnerabilities](https://snyk.io/test/github/configcat/js-ssr-sdk/badge.svg?targetFile=package.json)](https://snyk.io/test/github/configcat/js-ssr-sdk?targetFile=package.json)
1818

19+
:::caution
20+
This SDK is no longer maintained as it has been superseded by the new [Browser (JavaScript) SDK](../js/browser).
21+
22+
The new SDK maintains backward compatibility, so migration is typically as simple as:
23+
1. uninstalling the old NPM package,
24+
1. installing the new one,
25+
1. adjusting the `import` statements.
26+
27+
For installation details, see the [relavant section](../js/browser#1-install-and-import-package) in the new SDK's documentation.
28+
:::
29+
1930
:::info
2031
This SDK is for Server-Side Rendered JavaScript frameworks like <a href="https://nuxtjs.org" target="_blank">NuxtJS</a>.
2132
:::

‎website/docs/sdk-reference/js.mdx

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,15 @@ export const JavaScriptSchema = require('@site/src/schema-markup/sdk-reference/j
2020
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=configcat_js-sdk&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=configcat_js-sdk)
2121
[![JSDELIVR](https://data.jsdelivr.com/v1/package/npm/configcat-js/badge)](https://www.jsdelivr.com/package/npm/configcat-js)
2222

23-
:::info
24-
For JavaScript SSR (Server-Side Rendered) applications we recommend using [ConfigCat JS-SSR SDK](./js-ssr.mdx).
23+
:::caution
24+
This SDK is no longer maintained as it has been superseded by the new [Browser (JavaScript) SDK](../js/browser).
25+
26+
The new SDK maintains backward compatibility, so migration is typically as simple as:
27+
1. uninstalling the old NPM package,
28+
1. installing the new one,
29+
1. adjusting the `import` statements.
30+
31+
For installation details, see the [relavant section](../js/browser#1-install-and-import-package) in the new SDK's documentation.
2532
:::
2633

2734
<a href="https://github.com/configcat/js-sdk" target="_blank">

‎website/docs/sdk-reference/js/_template.mdx

Lines changed: 85 additions & 75 deletions
Large diffs are not rendered by default.

‎website/docs/sdk-reference/js/browser.mdx

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,19 @@ title: Browser (JavaScript) SDK
44
description: ConfigCat Browser (JavaScript) SDK Reference. This is a step-by-step guide on how to use feature flags in your frontend applications and Web Workers running in the browser.
55
---
66

7-
import JSSdkReferenceTemplate from "./\_template.mdx";
7+
import JSSdkReferenceTemplate, { getAdjustedToc } from "./\_template.mdx";
88

9+
{/* TODO */}
910
export const JavaScriptSchema = require('@site/src/schema-markup/sdk-reference/js.json');
1011

1112
<script
1213
type="application/ld+json"
1314
dangerouslySetInnerHTML={{ __html: JSON.stringify(JavaScriptSchema) }}
1415
></script>
1516

16-
<JSSdkReferenceTemplate platform="browser">
17-
</JSSdkReferenceTemplate>
17+
export const platform = "browser";
18+
19+
<JSSdkReferenceTemplate platform={platform}>
20+
</JSSdkReferenceTemplate>
21+
22+
export const toc = getAdjustedToc(platform);

‎website/docs/sdk-reference/js/bun.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Bun SDK
44
description: ConfigCat Bun SDK Reference. This is a step-by-step guide on how to use feature flags in your Bun applications.
55
---
66

7-
import JSSdkReferenceTemplate from "./\_template.mdx";
7+
import JSSdkReferenceTemplate, { getAdjustedToc } from "./\_template.mdx";
88

99
{/* TODO */}
1010
export const NodeSchema = require('@site/src/schema-markup/sdk-reference/node.json');
@@ -14,5 +14,9 @@ export const NodeSchema = require('@site/src/schema-markup/sdk-reference/node.js
1414
dangerouslySetInnerHTML={{ __html: JSON.stringify(NodeSchema) }}
1515
></script>
1616

17-
<JSSdkReferenceTemplate platform="bun">
18-
</JSSdkReferenceTemplate>
17+
export const platform = "bun";
18+
19+
<JSSdkReferenceTemplate platform={platform}>
20+
</JSSdkReferenceTemplate>
21+
22+
export const toc = getAdjustedToc(platform);

‎website/docs/sdk-reference/js/chromium-extension.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Chromium Extension SDK
44
description: ConfigCat Chromium Extension SDK Reference. This is a step-by-step guide on how to use feature flags in your extensions for Chromium-based browsers (Chrome, Edge, etc.)
55
---
66

7-
import JSSdkReferenceTemplate from "./\_template.mdx";
7+
import JSSdkReferenceTemplate, { getAdjustedToc } from "./\_template.mdx";
88

99
{/* TODO */}
1010
export const NodeSchema = require('@site/src/schema-markup/sdk-reference/node.json');
@@ -14,5 +14,9 @@ export const NodeSchema = require('@site/src/schema-markup/sdk-reference/node.js
1414
dangerouslySetInnerHTML={{ __html: JSON.stringify(NodeSchema) }}
1515
></script>
1616

17-
<JSSdkReferenceTemplate platform="chromium-extension">
18-
</JSSdkReferenceTemplate>
17+
export const platform = "chromium-extension";
18+
19+
<JSSdkReferenceTemplate platform={platform}>
20+
</JSSdkReferenceTemplate>
21+
22+
export const toc = getAdjustedToc(platform);

‎website/docs/sdk-reference/js/cloudflare-worker.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Cloudflare Worker SDK
44
description: ConfigCat Cloudflare Worker SDK Reference. This is a step-by-step guide on how to use feature flags in your Cloudflare Workers.
55
---
66

7-
import JSSdkReferenceTemplate from "./\_template.mdx";
7+
import JSSdkReferenceTemplate, { getAdjustedToc } from "./\_template.mdx";
88

99
{/* TODO */}
1010
export const NodeSchema = require('@site/src/schema-markup/sdk-reference/node.json');
@@ -14,5 +14,9 @@ export const NodeSchema = require('@site/src/schema-markup/sdk-reference/node.js
1414
dangerouslySetInnerHTML={{ __html: JSON.stringify(NodeSchema) }}
1515
></script>
1616

17-
<JSSdkReferenceTemplate platform="cloudflare-worker">
18-
</JSSdkReferenceTemplate>
17+
export const platform = "cloudflare-worker";
18+
19+
<JSSdkReferenceTemplate platform={platform}>
20+
</JSSdkReferenceTemplate>
21+
22+
export const toc = getAdjustedToc(platform);

‎website/docs/sdk-reference/js/deno.mdx

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Deno SDK
44
description: ConfigCat Deno SDK Reference. This is a step-by-step guide on how to use feature flags in your Deno applications.
55
---
66

7-
import JSSdkReferenceTemplate from "./\_template.mdx";
7+
import JSSdkReferenceTemplate, { getAdjustedToc } from "./\_template.mdx";
88

99
{/* TODO */}
1010
export const NodeSchema = require('@site/src/schema-markup/sdk-reference/node.json');
@@ -14,5 +14,9 @@ export const NodeSchema = require('@site/src/schema-markup/sdk-reference/node.js
1414
dangerouslySetInnerHTML={{ __html: JSON.stringify(NodeSchema) }}
1515
></script>
1616

17-
<JSSdkReferenceTemplate platform="deno">
18-
</JSSdkReferenceTemplate>
17+
export const platform = "deno";
18+
19+
<JSSdkReferenceTemplate platform={platform}>
20+
</JSSdkReferenceTemplate>
21+
22+
export const toc = getAdjustedToc(platform);

0 commit comments

Comments
 (0)