docs: improve README and add CONTRIBUTING guide #31
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 significantly refines the project's documentation to enhance clarity, improve the onboarding experience for new contributors, and align with the broader OpenFeature ecosystem. It introduces a dedicated contributing guide and comprehensively updates the main README, making it more user-friendly and consistent with official OpenFeature branding and content. 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.
Pull Request Overview
This PR improves the repository documentation by restructuring the README and adding a dedicated contributing guide, aligning with OpenFeature's documentation standards for openfeature.dev.
Key Changes:
- Enhanced README with OpenFeature branding, clearer structure, and improved quick start instructions
- Created CONTRIBUTING.md with development setup moved from README
- Reorganized configuration examples and tool documentation for better clarity
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Complete restructure with branding, improved quick start section, reorganized AI assistant configurations, enhanced tool documentation, and added community resources |
| CONTRIBUTING.md | New file containing development setup instructions, contribution guidelines, and community links previously in README |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request enhances the documentation for the OpenFeature MCP, improving the README and adding a CONTRIBUTING guide. The README has been reorganized with OpenFeature branding, clearer explanations, and less verbose examples. A new CONTRIBUTING.md file details the development setup. I have identified some areas for improvement, mainly focusing on clarity and consistency in the README file.
jonathannorris
force-pushed
the
docs-improve-readme-and-contributing
branch
from
2728975 to
1cdab14
Compare
Signed-off-by: Jonathan Norris <[email protected]>
Signed-off-by: Jonathan Norris <[email protected]>
Signed-off-by: Jonathan Norris <[email protected]>
Signed-off-by: Jonathan Norris <[email protected]>
Signed-off-by: Jonathan Norris <[email protected]>
jonathannorris
force-pushed
the
docs-improve-readme-and-contributing
branch
from
b7bfc53 to
c605bbe
Compare
Signed-off-by: Jonathan Norris <[email protected]>
…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 <[email protected]>
…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 <[email protected]>
Updates documentation to be used in openfeature.dev docs:
These changes align the repository documentation with the published openfeature.dev documentation structure.