Skip to content

Conversation

@aftersnow
Copy link
Contributor

Description

This PR fixes a structural inconsistency in the config.md documentation where the capabilities object and its child properties were incorrectly defined at the top level instead of being nested under the config object.

Changes made:

  • Moved all capabilities sub-properties (inputTypes, outputTypes, knowledgeCutoff, reasoning, toolUsage, reward, languages) from the incorrect top-level capabilities section to the correct location under config.capabilities
  • Removed the duplicate top-level capabilities definition (lines 150-182)
  • The documentation structure now correctly matches the example JSON provided in the same file

Related Issue

Motivation and Context

The documentation had a structural error where capabilities was defined twice:

  1. First as config.capabilities (line 134-136) with only a brief description
  2. Then as a top-level capabilities object (line 150-182) with all the detailed sub-properties

However, the example JSON in the document (lines 215-228) shows that capabilities should be nested under config, 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-level capabilities.*.

@gemini-code-assist
Copy link

Summary of Changes

Hello @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 config.md documentation. The primary goal is to correct the placement of the capabilities object and its child properties, ensuring they are properly nested under the config object as per the intended JSON schema. This change enhances clarity and accuracy for users referencing the documentation.

Highlights

  • Documentation Structure Correction: Moved all capabilities sub-properties (e.g., inputTypes, outputTypes, knowledgeCutoff) from an incorrect top-level definition to their proper nested location under config.capabilities in the config.md documentation.
  • Redundancy Removal: Eliminated a duplicate top-level capabilities definition that was causing structural inconsistency in the documentation.
  • Schema Alignment: Ensured the documentation structure now accurately reflects the example JSON schema, clarifying that capabilities properties should be accessed via config.capabilities.*.
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 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.

@aftersnow aftersnow added the documentation Improvements or additions to documentation label Nov 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants