docs: update OFREP API docs and fix script to generate ofrep/index.mdx (#1288)

jonathannorris · web-flow · commit 67ff96430731 · 2025-11-11T17:11:23.000Z
Updates the OFREP documentation generation script to output `ofrep/index.mdx` instead of `ofrep.mdx`, and regenerates SDK documentation. ## Changes - Temporarily sets OFREP OpenAPI spec to changes in: open-feature/protocol#56 - Updated `process-sdk-readmes.ts` to support custom filenames for other technologies - Set OFREP to generate `ofrep/index.mdx` and switched protocol repo branch to `main` - Updated `_category_.json` to reference the correct doc ID - Regenerated all SDK documentation files --------- Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
diff --git a/docs/reference/other-technologies/mcp.mdx b/docs/reference/other-technologies/mcp.mdx
@@ -13,6 +13,8 @@ It acts as a bridge between your AI assistant and OpenFeature capabilities, enab
 
 This server is published to the [MCP Registry](https://registry.modelcontextprotocol.io) under `dev.openfeature/mcp`.
 
+> **⚠️ AI Agent Behavior**: AI agents are non-deterministic and may not complete tasks correctly. Always manually review their changes before committing. If you encounter issues, please [open an issue](https://github.com/open-feature/mcp/issues) with details about your AI agent (e.g., Claude Code + Sonnet 4.5, Cursor + gpt-5-codex) with the commands you used and the behavior you saw.
+
 ## Quick Start
 
 ### NPX Install
diff --git a/docs/reference/other-technologies/ofrep/_category_.json b/docs/reference/other-technologies/ofrep/_category_.json
@@ -5,6 +5,6 @@
     "collapsed": false,
     "link": {
         "type": "doc",
-        "id": "reference/other-technologies/ofrep/index"
+        "id": "reference/other-technologies/ofrep/ofrep"
     }
 }
diff --git a/docs/reference/other-technologies/ofrep/index.mdx b/docs/reference/other-technologies/ofrep/index.mdx
@@ -1,14 +1,16 @@
 ---
 title: OpenFeature Remote Evaluation Protocol (OFREP)
-sidebar_position: 1
+sidebar_label: OFREP
+sidebar_position: 2
+id: ofrep
 ---
 
-The **OpenFeature Remote Evaluation Protocol (OFREP)** is an [API specification](./openapi) for feature flagging that enables vendor-agnostic communication between applications and flag management systems. It defines a standard API layer between the provider and the flag management system, allowing any OpenSource or commercial system to implement the protocol and be compatible with community-maintained providers.
+The **OpenFeature Remote Evaluation Protocol (OFREP)** is an [API specification](/docs/reference/other-technologies/ofrep/openapi) for feature flagging that enables vendor-agnostic communication between applications and flag management systems. It defines a standard API layer between the provider and the flag management system, allowing any open source or commercial system to implement the protocol and be compatible with community-maintained providers.
 
 ### Key Benefits
 
 - **Vendor Agnostic**: Connect to any OFREP-compliant flag management system without vendor-specific implementations
-- **Standardized**: Built on a [common OpenAPI specification](./openapi) for consistent integration
+- **Standardized**: Built on a common [OpenAPI specification](/docs/reference/other-technologies/ofrep/openapi) for consistent integration
 - **Flexible**: Works on both client-side and server-side applications
 - **Community Maintained**: Generic OFREP providers maintained by the OpenFeature project
 
@@ -27,7 +29,7 @@ graph LR
 1. Your application uses the OpenFeature SDK
 2. The OpenFeature SDK uses an OFREP provider
 3. The OFREP provider communicates with your flag management system via the standardized OFREP API
-4. Your flag management system implements the [OFREP specification](./openapi)
+4. Your flag management system implements the [OFREP specification](/docs/reference/other-technologies/ofrep/openapi)
 
 ### Server vs Client
 
@@ -61,15 +63,15 @@ Several flag management systems support OFREP. View the complete list of [OFREP-
 
 To create an OFREP provider for a new language:
 
-1. Review the [server provider guideline](https://github.com/open-feature/protocol/blob/docs-update-readme-for-website/guideline/dynamic-context-provider.md) or [client provider guideline](https://github.com/open-feature/protocol/blob/docs-update-readme-for-website/guideline/static-context-provider.md)
+1. Review the [server provider guideline](https://github.com/open-feature/protocol/blob/main/guideline/dynamic-context-provider.md) or [client provider guideline](https://github.com/open-feature/protocol/blob/main/guideline/static-context-provider.md)
 2. Implement the provider for your SDK according to the guidelines
 3. Register your provider in the [OpenFeature ecosystem](https://github.com/open-feature/openfeature.dev/issues)
 
 ### For Flag Management System Developers
 
 To make your flag management system OFREP-compliant:
 
-1. Implement the [OFREP OpenAPI specification](./openapi)
+1. Implement the [OFREP OpenAPI specification](/docs/reference/other-technologies/ofrep/openapi)
 2. Test your implementation with existing OFREP providers
 3. Register your system in the [OpenFeature ecosystem](https://github.com/open-feature/openfeature.dev/issues)
 
diff --git a/docs/reference/sdks/client/kotlin.mdx b/docs/reference/sdks/client/kotlin.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from kotlin-sdk.
 Edits should be made here: https://github.com/open-feature/kotlin-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Tue Oct 28 2025 11:19:13 GMT-0400 (Eastern Daylight Time)
+Last updated at Tue Nov 11 2025 12:07:26 GMT-0500 (Eastern Standard Time)
 -->
 import MCPInstall from '@site/src/partials/mcp-install';
 
diff --git a/docs/reference/sdks/client/swift.mdx b/docs/reference/sdks/client/swift.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from swift-sdk.
 Edits should be made here: https://github.com/open-feature/swift-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Tue Oct 28 2025 11:19:13 GMT-0400 (Eastern Daylight Time)
+Last updated at Tue Nov 11 2025 12:07:26 GMT-0500 (Eastern Standard Time)
 -->
 import MCPInstall from '@site/src/partials/mcp-install';
 
diff --git a/docs/reference/sdks/client/web/angular.mdx b/docs/reference/sdks/client/web/angular.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
 Edits should be made here: https://github.com/open-feature/js-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Tue Oct 28 2025 11:19:13 GMT-0400 (Eastern Daylight Time)
+Last updated at Tue Nov 11 2025 12:07:26 GMT-0500 (Eastern Standard Time)
 -->
 
 <p align="center" class="github-badges">
diff --git a/docs/reference/sdks/client/web/index.mdx b/docs/reference/sdks/client/web/index.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
 Edits should be made here: https://github.com/open-feature/js-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Tue Oct 28 2025 11:19:13 GMT-0400 (Eastern Daylight Time)
+Last updated at Tue Nov 11 2025 12:07:26 GMT-0500 (Eastern Standard Time)
 -->
 import MCPInstall from '@site/src/partials/mcp-install';
 
@@ -20,8 +20,8 @@ import MCPInstall from '@site/src/partials/mcp-install';
     <img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
   </a>
   
-  <a href="https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.7.0">
-    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.7.0&color=blue&style=for-the-badge" />
+  <a href="https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.7.1">
+    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.7.1&color=blue&style=for-the-badge" />
   </a>
   
   <br/>
diff --git a/docs/reference/sdks/client/web/react.mdx b/docs/reference/sdks/client/web/react.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
 Edits should be made here: https://github.com/open-feature/js-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Tue Oct 28 2025 11:19:13 GMT-0400 (Eastern Daylight Time)
+Last updated at Tue Nov 11 2025 12:07:26 GMT-0500 (Eastern Standard Time)
 -->
 import MCPInstall from '@site/src/partials/mcp-install';
 
@@ -20,8 +20,8 @@ import MCPInstall from '@site/src/partials/mcp-install';
     <img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge" />
   </a>
   
-  <a href="https://github.com/open-feature/js-sdk/releases/tag/react-sdk-v1.0.1">
-    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.0.1&color=blue&style=for-the-badge" />
+  <a href="https://github.com/open-feature/js-sdk/releases/tag/react-sdk-v1.0.2">
+    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.0.2&color=blue&style=for-the-badge" />
   </a>
   
   <br/>
diff --git a/docs/reference/sdks/server/dart.mdx b/docs/reference/sdks/server/dart.mdx
@@ -9,7 +9,7 @@ This content has been automatically generated from dart-server-sdk.
 Edits should be made here: https://github.com/open-feature/dart-server-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Tue Oct 28 2025 11:19:13 GMT-0400 (Eastern Daylight Time)
+Last updated at Tue Nov 11 2025 12:07:27 GMT-0500 (Eastern Standard Time)
 -->
 
 <p align="center" class="github-badges">
diff --git a/docs/reference/sdks/server/dotnet.mdx b/docs/reference/sdks/server/dotnet.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from dotnet-sdk.
 Edits should be made here: https://github.com/open-feature/dotnet-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Tue Oct 28 2025 11:19:13 GMT-0400 (Eastern Daylight Time)
+Last updated at Tue Nov 11 2025 12:07:25 GMT-0500 (Eastern Standard Time)
 -->
 import MCPInstall from '@site/src/partials/mcp-install';
 
diff --git a/docs/reference/sdks/server/go.mdx b/docs/reference/sdks/server/go.mdx
@@ -9,7 +9,7 @@ This content has been automatically generated from go-sdk.
 Edits should be made here: https://github.com/open-feature/go-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Tue Oct 28 2025 11:19:13 GMT-0400 (Eastern Daylight Time)
+Last updated at Tue Nov 11 2025 12:07:25 GMT-0500 (Eastern Standard Time)
 -->
 import MCPInstall from '@site/src/partials/mcp-install';
 
@@ -19,8 +19,8 @@ import MCPInstall from '@site/src/partials/mcp-install';
     <img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.7.0&color=yellow&style=for-the-badge" />
   </a>
   
-  <a href="https://github.com/open-feature/go-sdk/releases/tag/v1.16.0">
-    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.16.0&color=blue&style=for-the-badge" />
+  <a href="https://github.com/open-feature/go-sdk/releases/tag/v1.17.0">
+    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v1.17.0&color=blue&style=for-the-badge" />
   </a>
   
   <br/>
diff --git a/docs/reference/sdks/server/java.mdx b/docs/reference/sdks/server/java.mdx
@@ -9,7 +9,7 @@ This content has been automatically generated from java-sdk.
 Edits should be made here: https://github.com/open-feature/java-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Tue Oct 28 2025 11:19:12 GMT-0400 (Eastern Daylight Time)
+Last updated at Tue Nov 11 2025 12:07:25 GMT-0500 (Eastern Standard Time)
 -->
 import MCPInstall from '@site/src/partials/mcp-install';
 
diff --git a/docs/reference/sdks/server/javascript/index.mdx b/docs/reference/sdks/server/javascript/index.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
 Edits should be made here: https://github.com/open-feature/js-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Tue Oct 28 2025 11:19:13 GMT-0400 (Eastern Daylight Time)
+Last updated at Tue Nov 11 2025 12:07:25 GMT-0500 (Eastern Standard Time)
 -->
 import MCPInstall from '@site/src/partials/mcp-install';
 
diff --git a/docs/reference/sdks/server/javascript/nestjs.mdx b/docs/reference/sdks/server/javascript/nestjs.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
 Edits should be made here: https://github.com/open-feature/js-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Tue Oct 28 2025 11:19:13 GMT-0400 (Eastern Daylight Time)
+Last updated at Tue Nov 11 2025 12:07:25 GMT-0500 (Eastern Standard Time)
 -->
 import MCPInstall from '@site/src/partials/mcp-install';
 
diff --git a/docs/reference/sdks/server/php.mdx b/docs/reference/sdks/server/php.mdx
@@ -9,7 +9,7 @@ This content has been automatically generated from php-sdk.
 Edits should be made here: https://github.com/open-feature/php-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Tue Oct 28 2025 11:19:13 GMT-0400 (Eastern Daylight Time)
+Last updated at Tue Nov 11 2025 12:07:26 GMT-0500 (Eastern Standard Time)
 -->
 import MCPInstall from '@site/src/partials/mcp-install';
 
diff --git a/docs/reference/sdks/server/python.mdx b/docs/reference/sdks/server/python.mdx
@@ -9,7 +9,7 @@ This content has been automatically generated from python-sdk.
 Edits should be made here: https://github.com/open-feature/python-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Tue Oct 28 2025 11:19:13 GMT-0400 (Eastern Daylight Time)
+Last updated at Tue Nov 11 2025 12:07:25 GMT-0500 (Eastern Standard Time)
 -->
 import MCPInstall from '@site/src/partials/mcp-install';
 
diff --git a/docs/reference/sdks/server/ruby.mdx b/docs/reference/sdks/server/ruby.mdx
@@ -10,7 +10,7 @@ This content has been automatically generated from ruby-sdk.
 Edits should be made here: https://github.com/open-feature/ruby-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Tue Oct 28 2025 11:19:13 GMT-0400 (Eastern Daylight Time)
+Last updated at Tue Nov 11 2025 12:07:26 GMT-0500 (Eastern Standard Time)
 -->
 import MCPInstall from '@site/src/partials/mcp-install';
 
@@ -21,8 +21,8 @@ import MCPInstall from '@site/src/partials/mcp-install';
   </a>
   
 
-  <a href="https://github.com/open-feature/ruby-sdk/releases/tag/v0.4.0">
-    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.4.0&color=blue&style=for-the-badge" />
+  <a href="https://github.com/open-feature/ruby-sdk/releases/tag/v0.4.1">
+    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.4.1&color=blue&style=for-the-badge" />
   </a>
 
   
@@ -133,6 +133,43 @@ OpenFeature::SDK.configure do |config|
 end
 ```
 
+#### Blocking Provider Registration
+
+If you need to ensure that a provider is fully initialized before continuing, you can use `set_provider_and_wait`:
+
+```ruby
+# Using the SDK directly
+begin
+  OpenFeature::SDK.set_provider_and_wait(my_provider)
+  puts "Provider is ready!"
+rescue OpenFeature::SDK::ProviderInitializationError => e
+  puts "Provider failed to initialize: #{e.message}"
+  puts "Error code: #{e.error_code}"
+  puts "Original error: #{e.original_error}"
+end
+
+# With custom timeout (default is 30 seconds)
+OpenFeature::SDK.set_provider_and_wait(my_provider, timeout: 60)
+
+# Domain-specific provider
+OpenFeature::SDK.set_provider_and_wait(my_provider, domain: "feature-flags")
+
+# Via configuration block
+OpenFeature::SDK.configure do |config|
+  begin
+    config.set_provider_and_wait(my_provider)
+  rescue OpenFeature::SDK::ProviderInitializationError => e
+    # Handle initialization failure
+  end
+end
+```
+
+The `set_provider_and_wait` method:
+- Waits for the provider's `init` method to complete successfully
+- Raises `ProviderInitializationError` with `PROVIDER_FATAL` error code if initialization fails or times out
+- Provides access to the original error, provider instance, and error code for debugging
+- Uses the same thread-safe provider switching as `set_provider`
+
 In some situations, it may be beneficial to register multiple providers in the same application.
 This is possible using [domains](#domains), which is covered in more detail below.
 
diff --git a/docs/reference/sdks/server/rust.mdx b/docs/reference/sdks/server/rust.mdx
@@ -9,7 +9,7 @@ This content has been automatically generated from rust-sdk.
 Edits should be made here: https://github.com/open-feature/rust-sdk
 Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
 
-Last updated at Tue Oct 28 2025 11:19:13 GMT-0400 (Eastern Daylight Time)
+Last updated at Tue Nov 11 2025 12:07:27 GMT-0500 (Eastern Standard Time)
 -->
 
 <p align="center" class="github-badges">
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
@@ -292,7 +292,7 @@ const config: Config = {
         specs: [
           {
             id: 'ofrep-api',
-            spec: 'https://raw.githubusercontent.com/open-feature/protocol/refs/heads/main/service/openapi.yaml',
+            spec: 'https://raw.githubusercontent.com/open-feature/protocol/main/service/openapi.yaml',
           },
         ],
         theme: {
diff --git a/scripts/process-sdk-readmes.ts b/scripts/process-sdk-readmes.ts
@@ -262,10 +262,19 @@ export const processSdkReadmes = {
 /**
  * Other Technologies content configuration
  */
-// TODO: update branches to main once PRs are merged
-const OTHER_TECHNOLOGIES = [
+type OtherTechnology = {
+  repo: string;
+  id: string;
+  title: string;
+  label: string;
+  position: number;
+  branch: string;
+  filename?: string;
+};
+
+const OTHER_TECHNOLOGIES: OtherTechnology[] = [
   { repo: 'cli', id: 'cli', title: 'OpenFeature CLI', label: 'CLI', position: 1, branch: 'main' },
-  { repo: 'protocol', id: 'ofrep', title: 'OpenFeature Remote Evaluation Protocol (OFREP)', label: 'OFREP', position: 2, branch: 'docs-update-readme-for-website' },
+  { repo: 'protocol', id: 'ofrep', title: 'OpenFeature Remote Evaluation Protocol (OFREP)', label: 'OFREP', position: 2, branch: 'main', filename: 'ofrep/index.mdx' },
   { repo: 'mcp', id: 'mcp', title: 'OpenFeature MCP Server', label: 'MCP', position: 3, branch: 'main' },
 ];
 
@@ -306,6 +315,19 @@ id: ${tech.id}
       );
     };
 
+    // Replace service/openapi.yaml links with docs link for OFREP OpenAPI viewer
+    const replaceOFREPOpenApiLinks = (content: string): string => {
+      if (tech.id !== 'ofrep') return content;
+      
+      // Replace links to service/openapi.yaml with docs link
+      return content.replace(
+        /\[([^\]]+)\]\([^)]*service\/openapi\.yaml[^)]*\)/g,
+        (match, text) => {
+          return `[${text}](/docs/reference/other-technologies/ofrep/openapi)`;
+        }
+      );
+    };
+
     const processors = [
       carriageReturnsToNewLines,
       removeEmojisFromHeaders,
@@ -315,12 +337,13 @@ id: ${tech.id}
       removeExtraNewlinesBetweenSections,
       removeExtraNewlinesAtTop,
       fixRelativeLinks,
+      replaceOFREPOpenApiLinks,
     ];
 
     const content = processors.reduce((currentContent, processor) => processor(currentContent), initialContent);
 
     return {
-      filename: `${tech.id}.mdx`,
+      filename: tech.filename || `${tech.id}.mdx`,
       content: frontmatter + content,
     };
   },
diff --git a/src/datasets/sdks/sdk-compatibility.json b/src/datasets/sdks/sdk-compatibility.json
@@ -184,8 +184,8 @@
     "path": "/docs/reference/sdks/server/go",
     "category": "Server",
     "release": {
-      "href": "https://github.com/open-feature/go-sdk/releases/tag/v1.16.0",
-      "version": "1.16.0",
+      "href": "https://github.com/open-feature/go-sdk/releases/tag/v1.17.0",
+      "version": "1.17.0",
       "stable": true
     },
     "spec": {
@@ -364,8 +364,8 @@
     "path": "/docs/reference/sdks/client/web",
     "category": "Client",
     "release": {
-      "href": "https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.7.0",
-      "version": "1.7.0",
+      "href": "https://github.com/open-feature/js-sdk/releases/tag/web-sdk-v1.7.1",
+      "version": "1.7.1",
       "stable": true
     },
     "spec": {
@@ -532,8 +532,8 @@
     "path": "/docs/reference/sdks/server/ruby",
     "category": "Server",
     "release": {
-      "href": "https://github.com/open-feature/ruby-sdk/releases/tag/v0.4.0",
-      "version": "0.4.0",
+      "href": "https://github.com/open-feature/ruby-sdk/releases/tag/v0.4.1",
+      "version": "0.4.1",
       "stable": false
     },
     "spec": {

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,6 @@`
`5`	`5`	`"collapsed": false,`
`6`	`6`	`"link": {`
`7`	`7`	`"type": "doc",`
`8`		`- "id": "reference/other-technologies/ofrep/index"`
	`8`	`+ "id": "reference/other-technologies/ofrep/ofrep"`
`9`	`9`	`}`
`10`	`10`	`}`