From 5599f2c43c5c59ceb5beb7932a9567dcb7799883 Mon Sep 17 00:00:00 2001 From: Todd Baert Date: Tue, 31 Oct 2023 13:57:54 -0400 Subject: [PATCH 1/2] fix: api docs links Signed-off-by: Todd Baert --- packages/client/README.md | 2 +- packages/server/README.md | 2 +- packages/shared/README.md | 6 +++++- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/packages/client/README.md b/packages/client/README.md index 4c7cb9c23..787e0e3d0 100644 --- a/packages/client/README.md +++ b/packages/client/README.md @@ -84,7 +84,7 @@ if (v2Enabled) { ### API Reference -See [here](https://open-feature.github.io/js-sdk/modules/OpenFeature_Web_SDK.html) for the complete API documentation. +See [here](https://open-feature.github.io/js-sdk/modules/_openfeature_web_sdk.html) for the complete API documentation. ## 🌟 Features diff --git a/packages/server/README.md b/packages/server/README.md index 882423b97..2de9988aa 100644 --- a/packages/server/README.md +++ b/packages/server/README.md @@ -81,7 +81,7 @@ if (v2Enabled) { ### API Reference -See [here](https://open-feature.github.io/js-sdk/modules/OpenFeature_Server_SDK.html) for the complete API documentation. +See [here](https://open-feature.github.io/js-sdk/modules/_openfeature_server_sdk.html) for the complete API documentation. ## 🌟 Features diff --git a/packages/shared/README.md b/packages/shared/README.md index 2ade92a72..efbd5d546 100644 --- a/packages/shared/README.md +++ b/packages/shared/README.md @@ -18,4 +18,8 @@ This package comprises the common types and interfaces of the OpenFeature server and web SDKs. If you are developing a provider or a hook, you should instead utilize the [server](../server/README.md) or [web](../client/README.md) SDKs. This package is useful if you need to reference the underlying types common to all the JS SDKs, or if you're creating a utility that can be used to both server and web implementations. -Be sure to add this module as either a `devDependency` (if only build time assets such as types are required) or as a `peerDependency` with a permissive version expression. \ No newline at end of file +Be sure to add this module as either a `devDependency` (if only build time assets such as types are required) or as a `peerDependency` with a permissive version expression. + +### API Reference + +See [here](https://open-feature.github.io/js-sdk/modules/_openfeature_core.html) for the complete API documentation. \ No newline at end of file From a6e9caa96218f1e150f433727b2d0440753d1032 Mon Sep 17 00:00:00 2001 From: Todd Baert Date: Tue, 31 Oct 2023 13:59:52 -0400 Subject: [PATCH 2/2] fixup: tag also Signed-off-by: Todd Baert --- packages/client/README.md | 2 +- packages/server/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/client/README.md b/packages/client/README.md index 787e0e3d0..311a55b55 100644 --- a/packages/client/README.md +++ b/packages/client/README.md @@ -24,7 +24,7 @@ Project Status - + API Reference diff --git a/packages/server/README.md b/packages/server/README.md index 2de9988aa..41ebb042f 100644 --- a/packages/server/README.md +++ b/packages/server/README.md @@ -21,7 +21,7 @@
- + API Reference