docs: fix heading formatting in commands.md and phrasing in tools-api.md

[campox747]

Hi Team! I am an ICT student preparing for GSoC, and I'm excited to start contributing to the Gemini CLI. I am currently going through the documentation to familiarize myself with the architecture, and I found a couple of minor formatting/phrasing inconsistencies that I'd like to clean up.

Summary

Fixed heading hierarchy formatting in commands.md and refined phrasing in tools-api.md.

Details

• commands.md: fixed hierarchy and added missing colons to the /chat share sub-command to match formatting.
• tools-api.md: Updated phrase under the custom tools section for better readability.

Related Issues

#20843

How to Validate

Review the changed lines in docs/cli/commands.md and docs/core/tools-api.md

Pre-Merge Checklist

• Updated relevant documentation and README (if needed)
• Added/updated tests (if needed)
• Noted breaking changes (if any)
• Validated on required platforms/methods:
  • MacOS
    • npm run
    • npx
    • Docker
    • Podman
    • Seatbelt
  • Windows
    • npm run
    • npx
    • Docker
  • Linux
    • npm run
    • npx
    • Docker

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! 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 focuses on improving the clarity and consistency of the project's documentation. It addresses minor formatting issues and refines phrasing in key reference files, making the information more accessible and easier to understand for users and contributors.

Highlights

• Documentation Formatting: Corrected heading hierarchy in commands.md by removing an unnecessary subheading and ensured consistent colon usage for command descriptions.
• Phrasing Improvement: Enhanced readability in tools-api.md by refining a sentence describing the architecture's support for custom tool extensions.

Changelog

• docs/reference/commands.md
  • Removed the "### Built-in Commands" subheading to streamline the command list hierarchy.
  • Added missing colons after "Description" and "Usage" for the /chat share subcommand for consistent formatting.
• docs/reference/tools-api.md
  • Modified a sentence in the "Extending with custom tools" section to clarify that programmatic registration isn't explicitly detailed in this documentation, rather than in the provided files.

Activity

• No human activity has been recorded on this pull request since its creation.

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. ↩

[gemini-code-assist]

Code Review

This pull request introduces minor but helpful documentation updates. The changes in commands.md improve heading structure and formatting consistency. The phrasing update in tools-api.md enhances readability. The changes are correct and well-implemented. I have no further suggestions.

[Jomak-x]

Hi! Just a heads-up: for a PR to be officially accepted here, it usually needs to be linked to an existing issue.
"All PRs should be linked to an existing issue in our tracker. This ensures that every change has been discussed and is aligned with the project's goals before any code is written."

Here is the Contributors Guide.
https://github.com/google-gemini/gemini-cli/blob/main/CONTRIBUTING.md

Good luck applying for Gsoc.
@campox747

[campox747]

Hi @Jomak-x, thank you for the heads-up. So just to make it clear, should I always open an issue first before submitting a PR, even for minor documentation and formatting fixes like this?

[g-samroberts]

Looks like you need to resolve conflicts, as tools-api.md has changed. Also, please don't remove the "Build-in Commands" header.

[g-samroberts]

Please don't remove.

[campox747]

Ok added it back.

[g-samroberts]

I think there's a conflict here as this section no longer exists. you can undo this change and it should resolve the conflict.

[campox747]

Conflicts should be fixed now, thank you for your time!