- 
                Notifications
    
You must be signed in to change notification settings  - Fork 17
 
docs: update README.md formatting for openfeature.dev website docs #172
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
          Summary of ChangesHello @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 focuses on a significant update to the  Highlights
 Using Gemini Code AssistThe 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  
 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  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
  | 
    
There was a problem hiding this 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 improves the formatting and content of the README.md file, making it more suitable for the openfeature.dev website and clearer for users. The changes, such as adding more descriptive text, providing concrete examples, and improving the document structure, are beneficial. I've found one area in the Flag Manifest Structure documentation with some inaccuracies that could be improved for correctness and consistency. My detailed feedback is in the review comment.
923780e    to
    3d5ca21      
    Compare
  
    Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
0c271f1    to
    b95f5e1      
    Compare
  
    Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
…CLI, MCP, OFREP) (#1285) ## 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: - [open-feature/cli](https://github.com/open-feature/cli) - [open-feature/protocol](https://github.com/open-feature/protocol) - [open-feature/mcp](https://github.com/open-feature/mcp) - **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/mcp#31) [open-feature/protocol#55](open-feature/protocol#55) [open-feature/cli#172](open-feature/cli#172) --------- Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
…CLI, MCP, OFREP) (#1285) ## 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: - [open-feature/cli](https://github.com/open-feature/cli) - [open-feature/protocol](https://github.com/open-feature/protocol) - [open-feature/mcp](https://github.com/open-feature/mcp) - **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/mcp#31) [open-feature/protocol#55](open-feature/protocol#55) [open-feature/cli#172](open-feature/cli#172) --------- Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Updating the format of
README.mdto better format for adding the CLI to the openfeature.dev website. This README will be used for documentation underopenfeature.dev/docs/reference/other-technologies/cli, just as the SDKs docs are published from their repo's README's.