Skip to content

Conversation

@jonathannorris
Copy link
Member

Summary

Restructures documentation to separate OpenFeature SDKs from other technologies (OFREP, CLI, MCP) for better organization and discoverability.

Navigation Changes

Before

- Introduction
- Concepts
- Technologies
  - SDK Compatibility Overview
  - Server SDKs
  - Client SDKs
- Contributing

After

- Introduction
- Concepts
- SDKs
  - SDK Compatibility Overview
  - Server SDKs
  - Client SDKs
- Other Technologies
  - OFREP
  - CLI
  - MCP
- Contributing

Key Changes

  • Renamed: docs/reference/technologies/docs/reference/sdks/
  • Created: docs/reference/other-technologies/ with automated README fetching from:
  • Fixed: 171+ internal links across docs, blogs, and SDK files
  • Updated: docusaurus.config.ts, package.json, SDK datasets, and processing scripts

Technical Details

  • Added processOtherTechnologies export in scripts/process-sdk-readmes.ts
  • Converts relative links to absolute GitHub URLs
  • Automatically fixes /technologies//sdks/ in fetched content
  • Command: yarn update:sdk-docs now updates both SDKs and other technologies

Note

⚠️ Currently pulling from feature branches. Update to main once these PRs merge:
open-feature/mcp#31
open-feature/protocol#55
open-feature/cli#172

@jonathannorris jonathannorris requested review from a team as code owners October 24, 2025 19:18
@netlify
Copy link

netlify bot commented Oct 24, 2025

Deploy Preview for openfeature ready!

Name Link
🔨 Latest commit d143fae
🔍 Latest deploy log https://app.netlify.com/projects/openfeature/deploys/68ffb48041ebba00089c932e
😎 Deploy Preview https://deploy-preview-1285--openfeature.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @jonathannorris, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly refactors the documentation structure to improve clarity and user experience. By separating SDKs from other OpenFeature technologies like the CLI, OFREP, and MCP, users can more easily navigate and find relevant information. The changes involve extensive file renames, link updates, and enhancements to the automated documentation generation process to support the new organization.

Highlights

  • Documentation Restructure: The documentation has been reorganized to clearly separate OpenFeature SDKs from other related technologies like OFREP, CLI, and MCP, enhancing discoverability and organization.
  • New 'Other Technologies' Section: A new top-level navigation item and corresponding directory, 'docs/reference/other-technologies/', has been created to house documentation for OFREP, CLI, and MCP, which are now automatically fetched from their respective GitHub repositories.
  • Path Renaming: The primary documentation path for SDKs has been renamed from 'docs/reference/technologies/' to 'docs/reference/sdks/', impacting numerous internal links.
  • Link Fixes: Over 171 internal links across various documentation, blog posts, and SDK files have been updated to reflect the new documentation structure and paths.
  • Automated Content Processing: The Docusaurus configuration and content processing scripts have been updated to handle the new 'Other Technologies' section, including automated README fetching, conversion of relative links to absolute GitHub URLs, and fixing internal doc links during content generation.
  • Multi-Provider Support: The JavaScript (Web/Server) and .NET SDKs now include experimental Multi-Provider support, allowing the use of multiple underlying providers with configurable evaluation strategies. This feature has been added to the SDK compatibility matrix.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request effectively reorganizes the documentation by separating SDKs from other technologies like CLI, MCP, and OFREP. The changes, including directory renaming, extensive link updates, and configuration adjustments, are well-executed and improve the overall structure and discoverability of the documentation. I've identified a few minor issues in the newly added documentation for the CLI, such as a typo and some inconsistencies in code examples that could be confusing. Additionally, there's a small opportunity for cleanup in the .eslintignore file. Overall, this is a solid and beneficial update.

@jonathannorris jonathannorris force-pushed the docs-reorganize-nav-sdks-other-tech branch from 7a52e33 to 5598b2a Compare October 24, 2025 19:24
@beeme1mr
Copy link
Member

Thanks, @jonathannorris! This looks great so far. It would be nice to strip the "Get Involved" sections from the "Other Technologies" section but it isn't a deal breaker. There's an existing pattern for this in the SDK parser.

I'd like to come up with a better section title than "Other Technologies" but nothing comes to mind. Perhaps @moredip or @dyladan has an idea.

Copy link
Member

@toddbaert toddbaert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks! Good idea.

@toddbaert
Copy link
Member

Thanks, @jonathannorris! This looks great so far. It would be nice to strip the "Get Involved" sections from the "Other Technologies" section but it isn't a deal breaker. There's an existing pattern for this in the SDK parser.

I'd like to come up with a better section title than "Other Technologies" but nothing comes to mind. Perhaps @moredip or @dyladan has an idea.

Personally, I'm fine with "Other technologies", but I'm open to others as well.

@jonathannorris jonathannorris changed the title docs: reorganize navigation separating SDKs from other technologies (CLI, MCP, OFREP) docs: reorganize navigation separating SDKs from Other Technologies (CLI, MCP, OFREP) Oct 24, 2025
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
@jonathannorris jonathannorris force-pushed the docs-reorganize-nav-sdks-other-tech branch from a38786b to 8977fde Compare October 24, 2025 20:42
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
@jonathannorris jonathannorris added this pull request to the merge queue Oct 27, 2025
@jonathannorris jonathannorris removed this pull request from the merge queue due to a manual request Oct 27, 2025
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
@jonathannorris jonathannorris added this pull request to the merge queue Oct 27, 2025
Merged via the queue into main with commit f438823 Oct 27, 2025
9 checks passed
@jonathannorris jonathannorris deleted the docs-reorganize-nav-sdks-other-tech branch October 27, 2025 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants