Skip to content

Conversation

@jonathannorris
Copy link
Member

@jonathannorris jonathannorris commented Oct 24, 2025

Updating the format of README.md to better format for adding the CLI to the openfeature.dev website. This README will be used for documentation under openfeature.dev/docs/reference/other-technologies/cli, just as the SDKs docs are published from their repo's README's.

@gemini-code-assist
Copy link

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 focuses on a significant update to the README.md file, aiming to enhance the clarity, detail, and overall presentation of the OpenFeature CLI documentation. The changes provide users with a more comprehensive understanding of the CLI's features, supported languages, and how to engage with the project, ensuring the documentation is well-structured and informative for both new and existing users, particularly when viewed on the official website.

Highlights

  • Enhanced CLI Benefits Documentation: A new section has been added to the README.md, detailing the benefits of the OpenFeature CLI's approach to generating strongly typed flag accessors, emphasizing type safety, developer experience, and broad language support.
  • Improved Command Descriptions: The documentation for the openfeature init and openfeature generate commands has been significantly updated. The generate command now includes a comprehensive table listing all supported languages (TypeScript, JavaScript, React, Go, C#, Java, Python, NestJS, Node.js) for flag accessor generation.
  • Documentation Formatting and Structure: Various formatting adjustments were made across the README.md, including standardizing link descriptions, refining the flag manifest structure section, and promoting several sections ('Get Involved', 'Support the project', 'Thanks to everyone who has already contributed') to H2 headings for better readability and hierarchy.
  • Added GitHub Repository Link: A direct link to the GitHub repository has been added to the 'Get Involved' section, making it easier for users to find the project's source.
  • Website Documentation Control: An HTML comment <!-- x-hide-in-docs-start --> was introduced before the 'Support the project' section, likely to control its visibility when the README is rendered on the openfeature.dev website.
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

@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 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.

Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
@jonathannorris jonathannorris force-pushed the docs-update-readme-for-website branch from 0c271f1 to b95f5e1 Compare October 24, 2025 20:36
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
@beeme1mr beeme1mr added this pull request to the merge queue Oct 25, 2025
Merged via the queue into main with commit cd4b29f Oct 25, 2025
6 checks passed
@jonathannorris jonathannorris deleted the docs-update-readme-for-website branch October 27, 2025 15:12
github-merge-queue bot pushed a commit to open-feature/openfeature.dev that referenced this pull request Oct 27, 2025
…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>
github-merge-queue bot pushed a commit to open-feature/openfeature.dev that referenced this pull request Oct 27, 2025
…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>
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.

3 participants