-
Notifications
You must be signed in to change notification settings - Fork 287
docs(site): add docs about how to enable editor and interaction/plugin list #193
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @Aarebecca, 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 introduces extensive documentation for the "Editor" feature of the AntV Infographic library. The new content clarifies how to activate the editor, which facilitates in-browser manipulation of infographics through selection, dragging, and text editing. It also provides a detailed breakdown of the editor's architecture, comprising plugins for UI/features and interactions for input handling, alongside instructions for customization and extending functionality. Highlights
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this 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 adds documentation for the new editor feature, including how to enable it, its built-in plugins and interactions, and how to configure them. The changes include new documentation pages in both English and Chinese, as well as updates to the core concepts page and sidebar navigation to link to the new content.
The new documentation is well-structured and provides clear examples. I've found a minor issue in one of the code examples where a variable is used without being defined, which could confuse users. I've left suggestions to add comments to clarify this.
|
|
||
| infographic.render(syntax); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The syntax variable in infographic.render(syntax) is used without being defined in this example. This can be confusing for users and will lead to a ReferenceError if the code is copied directly. It would be helpful to add a comment to clarify what syntax represents.
| infographic.render(syntax); | |
| // The `syntax` variable represents your infographic definition. See "/learn/infographic-syntax". | |
| infographic.render(syntax); |
|
|
||
| infographic.render(syntax); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The syntax variable in infographic.render(syntax) is used without being defined in this example. This can be confusing for users and will lead to a ReferenceError if the code is copied directly. It would be helpful to add a comment to clarify what syntax represents.
| infographic.render(syntax); | |
| // `syntax` 变量代表信息图的定义。详见“信息图语法”章节。 | |
| infographic.render(syntax); |
|
在PR #192 中我把 |
No description provided.