Skip to content

docs(config): convert all configuration examples from TOML to YAML#179

Merged
AnnatarHe merged 1 commit intomainfrom
docs/convert-config-examples-to-yaml
Dec 29, 2025
Merged

docs(config): convert all configuration examples from TOML to YAML#179
AnnatarHe merged 1 commit intomainfrom
docs/convert-config-examples-to-yaml

Conversation

@AnnatarHe
Copy link
Copy Markdown
Contributor

Summary

  • Update file references from config.toml to config.yaml throughout documentation
  • Convert all configuration code examples from TOML to YAML syntax
  • Update README.md configuration section with YAML examples
  • Add note that TOML format is still supported (YAML takes priority)

Test plan

  • Verify YAML syntax is valid in all code blocks
  • Confirm documentation renders correctly on GitHub

🤖 Generated with Claude Code

- Update file references from config.toml to config.yaml
- Convert all code examples to YAML syntax
- Update README.md configuration section
- Add note that TOML format is still supported (YAML takes priority)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @AnnatarHe, 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 transitions the primary configuration documentation from TOML to YAML, aiming to provide more modern and widely adopted configuration examples. It updates all relevant file references and code snippets in the README.md and docs/CONFIG.md to use YAML syntax, while also clarifying that TOML remains a supported format.

Highlights

  • Configuration Format Transition: The primary configuration examples and references have been updated from TOML to YAML across the documentation.
  • Documentation Updates: Both README.md and docs/CONFIG.md have been revised to reflect the new YAML-based configuration, including file paths and code examples.
  • TOML Compatibility Note: A clear note has been added to the documentation indicating that while YAML is now prioritized, the TOML format remains supported.
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.

@AnnatarHe AnnatarHe merged commit b3846cf into main Dec 29, 2025
2 checks passed
@AnnatarHe AnnatarHe deleted the docs/convert-config-examples-to-yaml branch December 29, 2025 17:54
@codecov
Copy link
Copy Markdown

codecov Bot commented Dec 29, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

Flag Coverage Δ
unittests 20.05% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@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 successfully converts configuration examples from TOML to YAML throughout the documentation, which aligns with the new priority for YAML configuration files. The changes are comprehensive and the new YAML examples are syntactically correct. I found one minor inconsistency where an example value was changed during the format conversion, which I've flagged for correction to avoid user confusion. Overall, this is a solid documentation improvement.

Comment thread docs/CONFIG.md

```yaml
codeTracking:
enabled: true
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The value of enabled for codeTracking has been changed from false to true in this example. The primary goal of this pull request is to convert formats, not to alter example values. Furthermore, the table you've added on line 287 specifies that the default for codeTracking.enabled is false. To maintain consistency with both the previous documentation and the stated default value, it would be better to keep this as false.

Suggested change
enabled: true
enabled: false

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.

1 participant