Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 6, 2026

Synchronizes incremental content from G2's component documentation directory to Ant Design Charts' plots options, preserving ADC's code structure while adding missing properties, sections, and examples.

Completed Files (6/14)

Title (title.zh.md, title.en.md)

  • Added View-level configuration section
  • Enhanced property tables: added titleDx, titleDy, subtitleDx, subtitleDy with detailed descriptions
  • Added interactive customization examples

Scrollbar (scrollbar.zh.md, scrollbar.en.md)

  • Added View-level configuration with inheritance behavior
  • Enhanced thumb/track tables: added *LineDash, *Opacity, *Shadow*, *Cursor properties (14 total additions)

Slider (slider.zh.md)

  • Added "Common Interactions" section: sliderWheel configuration, sensitivity controls
  • Added "Adaptive Filtering" section: modes ('filter'/false), single/multi-axis scenarios, discrete vs continuous handling

Code Adaptation Pattern

All examples converted from G2 to ADC format while preserving structure:

// G2 format (source)
chart.options({
  type: 'interval',
  encode: { x: 'month', y: 'sales', color: 'category' },
  axis: { x: {} }
});

// ADC format (adapted)
{
  xField: 'month',
  yField: 'sales',
  colorField: 'category',
  axis: { x: {} }
}

Remaining Work (8/14)

Files requiring extensive sync due to large content deltas (20K-100K chars):

  • axis.zh/en (~1700 lines, missing sections: "刻度值格式化示例", "长刻度值标签处理方案详解")
  • label.zh/en (~1700 lines, ~19K char delta in configuration tables)
  • legend.zh/en (~2000 lines, ~19K char delta in configuration tables)
  • slider.en (minimal stub, needs ~795 lines)
  • tooltip.en (34→1000 lines needed)
Original prompt

http://github.com/antvis/g2/blob/v5/site/docs/manual/component 目录下的文档内容同步到 https://github.com/ant-design/ant-design-charts/blob/master/site/docs/options/plots/ 的同名文件中。

同步要求:

  1. 不能全量覆盖,同步增量内容即可
  2. 示例代码仅同步配置(options),代码结构不要改动

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@coderabbitai
Copy link

coderabbitai bot commented Jan 6, 2026

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot AI changed the title [WIP] Sync incremental documentation from G2 to Ant Design Charts Sync component documentation from G2 v5 to Ant Design Charts Jan 6, 2026
Copilot AI requested a review from lxfu1 January 6, 2026 08:44
@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Jan 7, 2026
@lxfu1 lxfu1 marked this pull request as ready for review January 7, 2026 07:09
@dosubot dosubot bot added the size:XL This PR changes 500-999 lines, ignoring generated files. label Jan 7, 2026
@lxfu1 lxfu1 merged commit 339d5d2 into master Jan 7, 2026
8 checks passed
@lxfu1 lxfu1 deleted the copilot/sync-g2-docs-to-ant-design-charts branch January 7, 2026 07:10
@dosubot dosubot bot added the documentation 📖 Improvements or additions to documentation label Jan 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 📖 Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:XL This PR changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants