docs: add guide-advise docs #907
Conversation
Summary of ChangesHello @Yzing, 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 new documentation for the 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds documentation for the advise method in both English and Chinese, and updates the styling for an image in the extract documentation. My review focuses on improving the correctness and clarity of the new documentation. I've pointed out a broken link, some issues with example JSON snippets (duplicate data, invalid syntax), and an invalid CSS property. Applying these suggestions will make the documentation more accurate and helpful for users.
| - /en/docs/guide/tech/advise | ||
| --- | ||
|
|
||
| The `advise` method provides chart recommendations. It takes natural language as input and outputs a configuration structure in **[antvSpec](/api/antv-spec/antv-spec)** format. This antvSpec can be used to render visualizations in **[gptvis]()** or other products that support the antvSpec format. |
There was a problem hiding this comment.
The link for gptvis is broken. It currently points to an empty destination. Based on the file structure, you probably intend to link to the gpt-vis render API page.
| The `advise` method provides chart recommendations. It takes natural language as input and outputs a configuration structure in **[antvSpec](/api/antv-spec/antv-spec)** format. This antvSpec can be used to render visualizations in **[gptvis]()** or other products that support the antvSpec format. | |
| The `advise` method provides chart recommendations. It takes natural language as input and outputs a configuration structure in **[antvSpec](/api/antv-spec/antv-spec)** format. This antvSpec can be used to render visualizations in **[gptvis](/api/render/gpt-vis)** or other products that support the antvSpec format. |
| { | ||
| "type": "line", | ||
| "data": [ | ||
| 1200000, | ||
| 1300000, | ||
| 1400000, | ||
| 1500000, | ||
| 1600000 | ||
| ], | ||
| "axisYTitle": "Sales (units)" | ||
| }, | ||
| { | ||
| "type": "line", | ||
| "data": [ | ||
| 2, | ||
| 2.5, | ||
| 3, | ||
| 3.5, | ||
| 4 | ||
| ], | ||
| "axisYTitle": "Return Rate (%)" | ||
| } |
There was a problem hiding this comment.
The series array in the example JSON output contains duplicate entries. The last two objects appear to be duplicates of the first two and should be removed to avoid confusion and present a correct example.
| - /zh/docs/guide/tech/advise | ||
| --- | ||
|
|
||
| `advise` 图表推荐方法，输入自然语言然后可推荐出 **[antvSpec](/api/antv-spec/antv-spec)** 的配置结构，antvSpec 可以用于 **[gptvis]()** 或其他支持 antvSpec 的产品进行渲染 |
There was a problem hiding this comment.
The link for gptvis is broken. It currently points to an empty destination. Based on the file structure, you probably intend to link to the gpt-vis render API page.
| `advise` 图表推荐方法，输入自然语言然后可推荐出 **[antvSpec](/api/antv-spec/antv-spec)** 的配置结构，antvSpec 可以用于 **[gptvis]()** 或其他支持 antvSpec 的产品进行渲染 | |
| `advise` 图表推荐方法，输入自然语言然后可推荐出 **[antvSpec](/api/antv-spec/antv-spec)** 的配置结构，antvSpec 可以用于 **[gptvis](/api/render/gpt-vis)** 或其他支持 antvSpec 的产品进行渲染 |
| - 输出为： | ||
| ```json | ||
| { | ||
| "type ": "dual-axes", |
There was a problem hiding this comment.
The JSON key "type " has a trailing space. This is likely a typo and can lead to confusion or parsing errors. Please remove the trailing space.
| "type ": "dual-axes", | |
| "type": "dual-axes", |
| { | ||
| "type": "line", | ||
| "data": [ | ||
| 1200000, | ||
| 1300000, | ||
| 1400000, | ||
| 1500000, | ||
| 1600000 | ||
| ], | ||
| "axisYTitle": "Sales (件)" | ||
| }, | ||
| { | ||
| "type": "line", | ||
| "data": [ | ||
| 2, | ||
| 2.5, | ||
| 3, | ||
| 3.5, | ||
| 4 | ||
| ], | ||
| "axisYTitle": "Return Rate (%)" | ||
| } |
There was a problem hiding this comment.
The series array in the example JSON output contains duplicate entries. The last two objects appear to be duplicates of the first two and should be removed to avoid confusion and present a correct example.
| - 输出为： | ||
| ```json | ||
| { | ||
| "type ": "network-graph", |
There was a problem hiding this comment.
The JSON key "type " has a trailing space. This is likely a typo and can lead to confusion or parsing errors. Please remove the trailing space.
| "type ": "network-graph", | |
| "type": "network-graph", |
|
|
||
| <img src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*pJ-9TJUrKHcAAAAAgFAAAAgAemJ7AQ/original"></img> | ||
| <div style="display:flex;justify-content:center"> | ||
| <img style="height: 200px;align: center" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*pJ-9TJUrKHcAAAAAgFAAAAgAemJ7AQ/original"></img> |
There was a problem hiding this comment.
The CSS property align: center is not valid. The align property is not a standard CSS property for styling. Since the parent div uses display: flex and justify-content: center, the image is already horizontally centered. The align property is unnecessary and should be removed.
| <img style="height: 200px;align: center" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*pJ-9TJUrKHcAAAAAgFAAAAgAemJ7AQ/original"></img> | |
| <img style="height: 200px;" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*pJ-9TJUrKHcAAAAAgFAAAAgAemJ7AQ/original"></img> |
|
|
||
| <img src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*aRzfT5N-ZvsAAAAAgFAAAAgAemJ7AQ/original"></img> | ||
| <div style="display:flex;justify-content:center"> | ||
| <img style="height: 200px;align: center" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*aRzfT5N-ZvsAAAAAgFAAAAgAemJ7AQ/original"></img> |
There was a problem hiding this comment.
The CSS property align: center is not valid. The align property is not a standard CSS property for styling. Since the parent div uses display: flex and justify-content: center, the image is already horizontally centered. The align property is unnecessary and should be removed.
| <img style="height: 200px;align: center" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*aRzfT5N-ZvsAAAAAgFAAAAgAemJ7AQ/original"></img> | |
| <img style="height: 200px;" src="https://mdn.alipayobjects.com/huamei_qa8qxu/afts/img/A*aRzfT5N-ZvsAAAAAgFAAAAgAemJ7AQ/original"></img> |
PR includes