Skip to content

fix docs#15

Merged
wangxingjun778 merged 1 commit intomainfrom
dev
Mar 20, 2026
Merged

fix docs#15
wangxingjun778 merged 1 commit intomainfrom
dev

Conversation

@wangxingjun778
Copy link
Collaborator

No description provided.

@wangxingjun778 wangxingjun778 merged commit e076ae9 into main Mar 20, 2026
1 check passed
@gemini-code-assist
Copy link

Summary of Changes

Hello, 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 primarily focuses on refining the documentation by addressing navigation inconsistencies, updating key statistics and integration surface descriptions, and standardizing image embedding practices. These changes aim to improve the accuracy, maintainability, and user experience of the documentation across different languages.

Highlights

  • Documentation Navigation Fixes: The 'Community' menu item in both English and Chinese configurations was updated to use url instead of pageRef to resolve issues with multilingual page paths.
  • Content Updates: The main index pages (_index.md and _index.zh.md) were updated to reflect an increased statistic from '5' to '6' and to include 'SKILL' in the list of integration surfaces.
  • Image Rendering Improvement: Image embedding in the OpenClaw recipe documentation (both English and Chinese versions) was refactored from HTML div and img tags to standard Markdown image syntax for better compatibility and readability.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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.

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 updates documentation, including fixing menu links for multilingual support, updating statistics on the homepage, and converting HTML image tags to Markdown syntax. The changes to the menu links are a good fix for known issues with Hugo's multilingual handling. My review focuses on the conversion to Markdown for images, which, while a good practice, may have unintended side effects on page layout by removing sizing and centering information. I've left comments with suggestions on how to mitigate this if it proves to be an issue.

<div align="center">
<img src="example2.png" alt="English OpenClaw TUI: Sirchmunk local file search with markdown answer" width="600" style="max-width: 100%; height: auto;" />
</div>
![English OpenClaw TUI: Sirchmunk local file search with markdown answer](example2.png "Sirchmunk search invoked inside OpenClaw TUI — English answer grounded in local files")

Choose a reason for hiding this comment

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

medium

Switching from raw HTML to Markdown for images is a good practice. However, this change (and the one on line 78) removes the width and centering attributes. This could lead to the images being too large and not centered. Please verify the rendered page to ensure the layout is still correct. If styling is needed, consider using a Hugo figure shortcode or Markdown attributes to control the presentation without raw HTML.

<div align="center">
<img src="example2.png" alt="英文 OpenClaw TUI:Sirchmunk 本地文件检索与 Markdown 格式回答" width="600" style="max-width: 100%; height: auto;" />
</div>
![英文 OpenClaw TUI:Sirchmunk 本地文件检索与 Markdown 格式回答](example2.png "在 OpenClaw TUI 中调用 Sirchmunk 搜索 — 英文回答基于本地文件生成")

Choose a reason for hiding this comment

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

medium

Similar to the English version of this document, converting the <img> tags to Markdown syntax (here and on line 78) is good, but it removes the width and centering attributes. This might cause the images to render at their full size and not be centered, which could affect the page layout. Please verify the rendered output.

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