Skip to content
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

【文档】录入组件API到 tdesign-api 平台 #1247

Closed
anlyyao opened this issue Mar 4, 2024 · 2 comments
Closed

【文档】录入组件API到 tdesign-api 平台 #1247

anlyyao opened this issue Mar 4, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation easy 简单问题 issueshoot 代码共建平台

Comments

@anlyyao
Copy link
Collaborator

anlyyao commented Mar 4, 2024

背景:

TDesign有一套自己的 API 维护工具,但是 TDesign 移动端的(tdesign-mobile-vue 和 tdesign-miniprogram)在过去半年的开发中,存在手动修改组件 API 文档且没有及时同步到 API 平台的问题,导致组件实际使用的API文档内容与API平台收录的内容不一致。

目标:

组件实际使用的 API 文档内容与 API 平台收录的内容保持一致。

操作流程指引:

如何录入组件API到tdesign-api平台

IssueShoot

  • 预估时长: 12
  • 期望完成时间: 2024-04-20 00:00:00 +0000 UTC
  • 开发难度: 低
  • 参与人数: 1
  • 需求对接人: anlyyao
  • 验收标准: 实现期望改造效果,提 PR 并通过验收无误
  • 备注: 最终激励以实际提交 pull request 并合并为准
@anlyyao anlyyao added the easy 简单问题 label Mar 4, 2024
Copy link
Contributor

github-actions bot commented Mar 4, 2024

👋 @anlyyao,感谢给 TDesign 提出了 issue。
请根据 issue 模版确保背景信息的完善,我们将调查并尽快回复你。

@anlyyao anlyyao added documentation Improvements or additions to documentation issueshoot 代码共建平台 labels Mar 4, 2024
@Tencent Tencent deleted a comment from liweijie0812 Apr 16, 2024
@anlyyao
Copy link
Collaborator Author

anlyyao commented Apr 16, 2024

See TDesignOteam/tdesign-api#264

@anlyyao anlyyao closed this as completed Apr 16, 2024
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 easy 简单问题 issueshoot 代码共建平台
Projects
None yet
Development

No branches or pull requests

1 participant