docs: update docusaurus to v3 (#5625)

* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
@@ -8,20 +8,20 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
## Implements
- [`IFlagRouter`](../interfaces/IFlagRouter.mdx)
- [IFlagRouter](../interfaces/IFlagRouter.mdx)
## Constructors
### constructor
**new FlagRouter**(`flags`)
`**new FlagRouter**(flags)`
#### Parameters
<ParameterTypes parameters={[
{
"name": "flags",
"type": "Record<`string`, `boolean` \\| Record<`string`, `boolean`\\>\\>",
"type": "`Record<string, boolean \\| Record&#60;string, boolean&#62;>`",
"description": "",
"optional": false,
"defaultValue": "",
@@ -48,7 +48,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
### isFeatureEnabled
**isFeatureEnabled**(`flag`): `boolean`
`**isFeatureEnabled**(flag): boolean`
Check if a feature flag is enabled.
There are two ways of using this method:
@@ -63,7 +63,7 @@ An example of a nested flag is workflows. To use it, you would do:
<ParameterTypes parameters={[
{
"name": "flag",
"type": "`string` \\| Record<`string`, `string`\\>",
"type": "`string` \\| `Record<string, string>`",
"description": "The flag to check",
"optional": false,
"defaultValue": "",
@@ -92,16 +92,16 @@ ___
### listFlags
**listFlags**(): [`FeatureFlagsResponse`](../types/FeatureFlagsResponse.mdx)
`**listFlags**(): [FeatureFlagsResponse](../types/FeatureFlagsResponse.mdx)`
#### Returns
[`FeatureFlagsResponse`](../types/FeatureFlagsResponse.mdx)
[FeatureFlagsResponse](../types/FeatureFlagsResponse.mdx)
<ParameterTypes parameters={[
{
"name": "FeatureFlagsResponse",
"type": "{ `key`: `string` ; `value`: `boolean` \\| Record<`string`, `boolean`\\> }[]",
"type": "`&#123; key: string ; value: boolean \\| Record&#60;string, boolean&#62; &#125;`[]",
"description": "",
"optional": false,
"defaultValue": "",
@@ -114,12 +114,12 @@ ___
### setFlag
**setFlag**(`key`, `value`): `void`
`**setFlag**(key, value): void`
Sets a feature flag.
Flags take two shapes:
setFlag("myFeatureFlag", true)
setFlag("myFeatureFlag", { nestedFlag: true })
`setFlag("myFeatureFlag", true)`
`setFlag("myFeatureFlag", { nestedFlag: true })`
These shapes are used for top-level and nested flags respectively, as explained in isFeatureEnabled.
#### Parameters
@@ -136,7 +136,7 @@ These shapes are used for top-level and nested flags respectively, as explained
},
{
"name": "value",
"type": "`boolean` \\| { `[key: string]`: `boolean`; }",
"type": "`boolean` \\| `&#123; [key: string]: boolean; &#125;`",
"description": "The value of the flag to set.",
"optional": false,
"defaultValue": "",