Skip to content

征集文档错误

TechUI 是一个高速迭代的项目。由于 “一人 + AI” 的开发模式推进极快,我们的文档编写速度有时不得不向代码迭代速度妥协。

坦率地说,目前的文档构建较为仓促,存在着不少疏漏与空白。我们需要您的火眼金睛,帮助我们填补这些缺失。

已知的不完善之处

在使用过程中,您可能会遇到以下文档缺失的情况,这并非功能缺失,而是文档尚未跟上:

  1. CSS 变量定义 (CSS Variables)

    • 现状:TechUI 的绝大多数组件在设计底层都预留了丰富的 CSS Variables 用于样式定制。但在目前的文档 API 列表中,可能并未将这些变量一一列出。
    • 说明:如果您发现无法通过 Props 修改样式,通常可以通过覆盖 CSS Var 来实现。如果您发现了文档中未提及的 CSS Var,欢迎提交给我们补充。
  2. 缺少 Demo 演示

    • 现状:部分新组件可能仅有基础的代码片段,缺乏直观的交互式 Demo。
  3. 测试用例不完备

    • 现状:为了快速交付,部分组件文档中的单元测试代码 (Test Cases) 可能较为简略或尚未上传。

如何提交反馈?

如果您在使用过程中发现了文档的错误(错别字、链接失效、参数描述错误),或者发现了上述的“文档缺失”部分,请务必告诉我们。

您可以通过以下方式参与文档共建:

  • 提交 Issue:在 GitHub Issues 中使用 [Doc] 标签反馈。
  • 直接 PR:如果您知道如何修复,直接提交 Pull Request 是最受欢迎的方式。
  • 补充 CSS Var:如果您在源码中挖掘到了好用的隐藏 CSS 变量,请告诉我们,我们会将其更新到文档中,造福更多开发者。

文档即产品

我们深知,一份好的文档与高质量的代码同等重要。 感谢您对 TechUI 文档“半成品”状态的包容,您的每一次反馈,都在让这份说明书变得更厚实、更精准。

联系我们

征集文档错误,请通过下面的方式联系TechUI

社区方式

邮件方式