Skip to content

docs: 优化【快速上手】等文档#4788

Merged
GaoFuhong merged 3 commits into
masterfrom
docs_tutorial
Oct 16, 2025
Merged

docs: 优化【快速上手】等文档#4788
GaoFuhong merged 3 commits into
masterfrom
docs_tutorial

Conversation

@q32757468
Copy link
Copy Markdown
Contributor

@q32757468 q32757468 commented Sep 22, 2025

Description

整理了一部分想法作为基本的可参考项,方便社区同学拓展和改造:
#4790

等这个PR合并之后也可以作为基本的参考PR之一方便后续的文档改造PR

Motivation and Context

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Enhancement (changes that improvement of current feature or performance)
  • Refactoring (changes that neither fixes a bug nor adds a feature)
  • Test Case (changes that add missing tests or correct existing tests)
  • Code style optimization (changes that do not affect the meaning of the code)
  • Docs (changes that only update documentation)
  • Chore (changes that don't modify src or test files)

Self Check before Merge

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @q32757468, 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!

此拉取请求主要侧重于对 X6 文档和教程进行实质性修订。这些更改旨在为用户提供更结构化、更详细、更易于访问的学习体验,涵盖从初始设置和基本画布操作到与流行前端框架集成等内容。此次更新还优化了文档导航,以提高资源的可发现性。

Highlights

  • 文档导航优化: 文档导航中的“常见问题”部分已更新为下拉菜单,将“社区文档”和“官方文档”分开,以便更好地组织。
  • 增强的画布教程: site/docs/tutorial/basic/graph.zh.md 文件已进行大量重写,提供了更详细、更丰富的画布(Graph)功能教程,包括画布大小、背景、网格、缩放、平移以及画布插件(如 Scroller 和 Snapline)的介绍。
  • 改进的入门指南: site/docs/tutorial/getting-started.zh.md 教程已更新,提供了更清晰的安装说明(包括 pnpm),新增了关于将 X6 与 React、Vue 和 Angular 框架集成的部分,以及更全面的节点/边渲染和插件使用代码示例。
  • CDN 链接更新: 入门指南中 cdnjs.cloudflare.com 的 CDN 链接已更新为 X6 的新版本。
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

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

本次 PR 对文档教程进行了大幅度的重构和内容补充,整体上提升了文档的质量和可读性,非常棒的工作!我主要针对一些文档中的代码示例错误、格式问题和文本表述进行了审查,并提出了一些修改建议,希望能帮助文档变得更加完善。具体包括:修正了代码示例中的颜色值和缩进错误,统一了 Markdown 中内联代码的格式,改进了代码块的语言标识以获得更好的语法高亮,并修正了一些文本中的语法错误和拼写错误。

Comment thread site/docs/tutorial/basic/graph.zh.md Outdated
Comment thread site/docs/tutorial/basic/graph.zh.md Outdated
Comment thread site/docs/tutorial/basic/graph.zh.md Outdated
Comment thread site/docs/tutorial/basic/graph.zh.md Outdated
Comment thread site/docs/tutorial/basic/graph.zh.md Outdated
Comment thread site/docs/tutorial/getting-started.zh.md Outdated
Comment thread site/docs/tutorial/getting-started.zh.md Outdated
Comment thread site/docs/tutorial/getting-started.zh.md Outdated
Comment thread site/docs/tutorial/getting-started.zh.md Outdated
Comment thread site/docs/tutorial/getting-started.zh.md Outdated
Comment thread site/.dumirc.ts
@q32757468 q32757468 changed the title Docs tutorial docs: 优化【快速上手】等文档 Sep 22, 2025
Comment thread site/docs/tutorial/getting-started.zh.md Outdated
Comment thread site/docs/tutorial/getting-started.zh.md Outdated
Comment thread site/docs/tutorial/getting-started.zh.md Outdated
Comment thread site/docs/tutorial/getting-started.zh.md Outdated
Comment thread site/docs/tutorial/getting-started.zh.md Outdated
Comment thread site/docs/tutorial/basic/graph.zh.md Outdated
Comment thread site/docs/tutorial/basic/graph.zh.md Outdated
Comment thread site/docs/tutorial/basic/graph.zh.md Outdated
@q32757468 q32757468 marked this pull request as draft October 13, 2025 09:12
@q32757468 q32757468 marked this pull request as ready for review October 16, 2025 03:53
@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.92%. Comparing base (0df719e) to head (d75ac56).
⚠️ Report is 24 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #4788      +/-   ##
==========================================
- Coverage   82.23%   81.92%   -0.31%     
==========================================
  Files         328      327       -1     
  Lines       37613    37962     +349     
  Branches     7584     7635      +51     
==========================================
+ Hits        30930    31102     +172     
- Misses       6659     6836     +177     
  Partials       24       24              
Flag Coverage Δ
x6 81.92% <ø> (-0.31%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 20 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@GaoFuhong GaoFuhong merged commit f317fe1 into master Oct 16, 2025
2 checks passed
@GaoFuhong GaoFuhong deleted the docs_tutorial branch October 16, 2025 05:55
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.

3 participants