Skip to content

Conversation

Willaaaaaaa
Copy link
Contributor

@Willaaaaaaa Willaaaaaaa commented Oct 2, 2025

Main changes:

  • add anchors and version info
  • improve readability
  • add doc for check.target_package_licenses

主要修改:

  • 修改了原来右侧无目录的问题,修复了中英文切换不对应问题
  • 我改动了已有的两个 check 文档,主要是更详细,可读性更强了
  • 添加了 check.target_package_licenses 这个策略的文档

麻烦 ruki 老师看看这种修改符不符合您对文档的期待。主要是感觉现有的文档对有经验的人来说不是什么大问题,但对新手不是特别易读,所以我重新规划修改了一下原有内容,主要是更详细更书面了一点吧(),希望没有错误。英文大多是我自己翻的,原有的英文实在是不太好读,可能您看完中文后可能还需要去 dc 上看能不能找个老外检查一遍。 gemini 检查了一遍,其实应该也行了。

Copy link

vercel bot commented Oct 2, 2025

@Willaaaaaaa is attempting to deploy a commit to the waruqi's projects Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

netlify bot commented Oct 2, 2025

Deploy Preview for mellow-creponne-9cce3d ready!

Name Link
🔨 Latest commit a6b0bf4
🔍 Latest deploy log https://app.netlify.com/projects/mellow-creponne-9cce3d/deploys/68de9069f40535000829d88d
😎 Deploy Preview https://deploy-preview-241--mellow-creponne-9cce3d.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

Summary of Changes

Hello @Willaaaaaaa, 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 focuses on a comprehensive overhaul of the built-in policies documentation for Xmake. The changes aim to make the documentation more structured, readable, and informative by adding versioning, improving explanations for existing policies, and introducing a new policy related to license compatibility. The goal is to provide users with clearer guidance on how to understand and configure Xmake's default behaviors.

Highlights

  • Documentation Structure and Readability: The documentation for built-in policies has been significantly improved with the addition of version badges, anchors, and a more logical sectioning, enhancing overall readability and navigation.
  • New License Policy: A new policy, "check.target_package_licenses", has been introduced and documented, providing users with a mechanism to check license compatibility for dependencies.
  • Enhanced Policy Explanations: Existing policies, particularly "check.auto_ignore_flags" and "check.auto_map_flags", now feature more detailed explanations, including their default behaviors, use cases, and potential risks, making them clearer for users.
  • Bilingual Content Refinement: Both English and Chinese versions of the documentation have been updated, with specific attention to improving phrasing and formality in the Chinese text.
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

这次 PR 对内置策略的文档进行了很好的重构和改进,非常出色。新的文档结构对用户,特别是新手来说,更加清晰易懂。此外,增加了 check.target_package_licenses 策略的文档也是一个很有价值的贡献。

我发现了一些可以进一步提升文档可读性的小问题,并修正了一些在中英文文档中的拼写和格式错误。总的来说,这是一次高质量的文档改进。

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