-
Notifications
You must be signed in to change notification settings - Fork 20
docs: move capabilities fields to correct location under config #139
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
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @aftersnow, 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 addresses a structural inconsistency within 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 correctly refactors the docs/config.md file to place the capabilities properties under the config object, resolving a structural inconsistency in the documentation. The change aligns the documentation with the example JSON and the Go specification. I've suggested a couple of minor wording improvements for clarity. Overall, this is a good improvement to the documentation's accuracy and readability.
As a side note, I noticed that schema/config-schema.json appears to be out of sync with these changes and the Go spec, as it's missing the reward and languages fields under ModelCapabilities. This is outside the scope of this PR, but it might be worth addressing in a future change to ensure all parts of the specification are consistent.
…s fields Signed-off-by: Zhao Chen <[email protected]>
ff18444 to
3958c4a
Compare
Description
This PR fixes a structural inconsistency in the config.md documentation where the
capabilitiesobject and its child properties were incorrectly defined at the top level instead of being nested under theconfigobject.Changes made:
capabilitiessub-properties (inputTypes,outputTypes,knowledgeCutoff,reasoning,toolUsage,reward,languages) from the incorrect top-levelcapabilitiessection to the correct location underconfig.capabilitiescapabilitiesdefinition (lines 150-182)Related Issue
Motivation and Context
The documentation had a structural error where
capabilitieswas defined twice:config.capabilities(line 134-136) with only a brief descriptioncapabilitiesobject (line 150-182) with all the detailed sub-propertiesHowever, the example JSON in the document (lines 215-228) shows that
capabilitiesshould be nested underconfig, not at the top level. This inconsistency could confuse users implementing the specification.This fix ensures the documentation structure aligns with the actual JSON schema, making it clear that the correct path is
config.capabilities.*rather than top-levelcapabilities.*.