Skip to content

feat(docs): 初始化 GFramework 文档站点配置#154

Merged
GeWuYou merged 1 commit into
mainfrom
docs/source-generators-complete-documentation
Mar 31, 2026
Merged

feat(docs): 初始化 GFramework 文档站点配置#154
GeWuYou merged 1 commit into
mainfrom
docs/source-generators-complete-documentation

Conversation

@GeWuYou

@GeWuYou GeWuYou commented Mar 31, 2026

Copy link
Copy Markdown
Owner
  • 添加 VitePress 配置文件,设置文档标题和描述
  • 实现安全泛型转义插件,保护代码块和 HTML 标签
  • 配置多语言支持,设置简体中文为默认语言
  • 设置文档导航栏,包含入门指南、核心框架、ECS 等模块
  • 配置侧边栏结构,按模块划分文档目录
  • 添加本地搜索功能,配置中文翻译选项
  • 设置 GitHub Pages 部署基础路径
  • 配置社交链接和页脚信息

Summary by Sourcery

新功能:

  • 在中文版文档侧边栏中,为 Godot 源代码生成器 GetNodeBindNodeSignal 添加导航条目。
Original summary in English

Summary by Sourcery

New Features:

  • Add navigation entries for the GetNode and BindNodeSignal Godot source generators in the Chinese documentation sidebar.

- 添加 VitePress 配置文件,设置文档标题和描述
- 实现安全泛型转义插件,保护代码块和 HTML 标签
- 配置多语言支持,设置简体中文为默认语言
- 设置文档导航栏,包含入门指南、核心框架、ECS 等模块
- 配置侧边栏结构,按模块划分文档目录
- 添加本地搜索功能,配置中文翻译选项
- 设置 GitHub Pages 部署基础路径
- 配置社交链接和页脚信息
@sourcery-ai

sourcery-ai Bot commented Mar 31, 2026

Copy link
Copy Markdown
审阅者指南(在小型 PR 上折叠显示)

审阅者指南

通过在源码生成器(source-generators)部分的简体中文导航菜单中,新增两个与 Godot 相关的源码生成器条目,扩展现有的 VitePress 文档站点配置。

更新后的 zh-CN 源码生成器导航结构流程图

graph TD
  Source_generators_menu["Source generators menu zh CN"]

  Source_generators_menu --> Enum_extension["枚举扩展 enum generator"]
  Source_generators_menu --> ContextAware_generator["ContextAware 生成器"]
  Source_generators_menu --> Priority_generator["Priority 生成器"]
  Source_generators_menu --> ContextGet_injection["Context Get 注入"]
  Source_generators_menu --> GetNode_generator_Godot["GetNode 生成器 Godot"]
  Source_generators_menu --> BindNodeSignal_generator_Godot["BindNodeSignal 生成器 Godot"]
Loading

文件级变更

变更 详情 文件
在简体中文部分的源码生成器导航菜单中,新增两个与 Godot 相关的生成器文档链接。
  • 添加指向 /zh-CN/source-generators/get-node-generator 路由的 GetNode 生成器(Godot)导航条目
  • 添加指向 /zh-CN/source-generators/bind-node-signal-generator 路由的 BindNodeSignal 生成器(Godot)导航条目
  • 确保新增条目遵循现有的导航数组结构以及末尾逗号风格
docs/.vitepress/config.mts

技巧与命令

与 Sourcery 交互

  • 触发新的审阅: 在 pull request 中评论 @sourcery-ai review
  • 继续讨论: 直接回复 Sourcery 的审阅评论。
  • 从审阅评论生成 GitHub issue: 通过回复审阅评论请求 Sourcery 从该评论创建 issue。你也可以直接回复审阅评论 @sourcery-ai issue 来从中创建一个 issue。
  • 生成 pull request 标题: 在 pull request 标题中任意位置写上 @sourcery-ai,即可随时生成标题。你也可以在 pull request 中评论 @sourcery-ai title 来(重新)生成标题。
  • 生成 pull request 摘要: 在 pull request 描述正文任意位置写上 @sourcery-ai summary,即可在该位置生成 PR 摘要。你也可以在 pull request 中评论 @sourcery-ai summary 来在任意时间(重新)生成摘要。
  • 生成审阅者指南: 在 pull request 中评论 @sourcery-ai guide,即可在任意时间(重新)生成审阅者指南。
  • 解决所有 Sourcery 评论: 在 pull request 中评论 @sourcery-ai resolve,即可将所有 Sourcery 评论标记为已解决。如果你已经处理完所有评论且不想再看到它们,这会很有用。
  • 忽略所有 Sourcery 审阅: 在 pull request 中评论 @sourcery-ai dismiss,即可忽略所有现有的 Sourcery 审阅。如果你想从头开始一次新的审阅,这尤其有用——别忘了再评论 @sourcery-ai review 以触发新的审阅!

自定义你的使用体验

访问你的控制面板 可以:

  • 启用或禁用审阅功能,例如 Sourcery 生成的 pull request 摘要、审阅者指南等。
  • 更改审阅语言。
  • 添加、移除或编辑自定义审阅说明。
  • 调整其他审阅设置。

获取帮助

Original review guide in English
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Extends the existing VitePress documentation site configuration by adding two new Godot-related source generator entries to the Simplified Chinese navigation menu under the source-generators section.

Flow diagram for updated zh-CN source generators navigation structure

graph TD
  Source_generators_menu["Source generators menu zh CN"]

  Source_generators_menu --> Enum_extension["枚举扩展 enum generator"]
  Source_generators_menu --> ContextAware_generator["ContextAware 生成器"]
  Source_generators_menu --> Priority_generator["Priority 生成器"]
  Source_generators_menu --> ContextGet_injection["Context Get 注入"]
  Source_generators_menu --> GetNode_generator_Godot["GetNode 生成器 Godot"]
  Source_generators_menu --> BindNodeSignal_generator_Godot["BindNodeSignal 生成器 Godot"]
Loading

File-Level Changes

Change Details Files
Extend the source-generators navigation menu with two new Godot-related generator docs links in the Simplified Chinese section.
  • Add a navigation entry for the GetNode generator (Godot) pointing to the /zh-CN/source-generators/get-node-generator route
  • Add a navigation entry for the BindNodeSignal generator (Godot) pointing to the /zh-CN/source-generators/bind-node-signal-generator route
  • Ensure the new entries follow the existing navigation array structure and trailing comma style
docs/.vitepress/config.mts

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - 我已经查看了你的更改,一切看起来都很不错!


Sourcery 对开源项目完全免费 —— 如果你觉得我们的代码审查对你有帮助,欢迎分享给更多人 ✨
帮我变得更有用吧!请在每条评论上点 👍 或 👎,我会根据你的反馈来改进后续的代码审查。
Original comment in English

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@GeWuYou GeWuYou merged commit 783570b into main Mar 31, 2026
6 checks passed
@GeWuYou GeWuYou deleted the docs/source-generators-complete-documentation branch March 31, 2026 10:41
@deepsource-io

deepsource-io Bot commented Mar 31, 2026

Copy link
Copy Markdown

DeepSource Code Review

We reviewed changes in 059d5a8...24dc2bb on this pull request. Below is the summary for the review, and you can see the individual issues we found as inline review comments.

See full review on DeepSource ↗

PR Report Card

Overall Grade   Security  

Reliability  

Complexity  

Hygiene  

Code Review Summary

Analyzer Status Updated (UTC) Details
C# Mar 31, 2026 11:35a.m. Review ↗
Secrets Mar 31, 2026 11:35a.m. Review ↗

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