-
Notifications
You must be signed in to change notification settings - Fork 86
docs: reorganize navigation separating SDKs from Other Technologies (CLI, MCP, OFREP) #1285
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
✅ Deploy Preview for openfeature ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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 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
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 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.
7a52e33 to
5598b2a
Compare
|
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. |
toddbaert
left a comment
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.
LGTM, thanks! Good idea.
Personally, I'm fine with "Other technologies", but I'm open to others as well. |
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>
a38786b to
8977fde
Compare
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Signed-off-by: Jonathan Norris <jonathan@taplytics.com>
Summary
Restructures documentation to separate OpenFeature SDKs from other technologies (OFREP, CLI, MCP) for better organization and discoverability.
Navigation Changes
Before
After
Key Changes
docs/reference/technologies/→docs/reference/sdks/docs/reference/other-technologies/with automated README fetching from:docusaurus.config.ts,package.json, SDK datasets, and processing scriptsTechnical Details
processOtherTechnologiesexport inscripts/process-sdk-readmes.ts/technologies/→/sdks/in fetched contentyarn update:sdk-docsnow updates both SDKs and other technologiesNote
mainonce these PRs merge:open-feature/mcp#31
open-feature/protocol#55
open-feature/cli#172