patternfly / patternfly/patternfly-react

Consider adding Type documentation

未关闭
#9,767 7 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Good first issue Stale
主要语言
TypeScript
星标
862
派生
392
平均合并
4 天 8 小时
30 天内合并 PR
9

描述

Describe the enhancement or change
Branching off from a conversation at https://github.com/patternfly/patternfly-react/pull/9709#pullrequestreview-1690213766, our Wizard component has several types that aren't really documented, but are still mentioned in the Prop tables. For example the Wizard's nav prop has a type of WizardNavType, which itself includes the CustomWizardNavFunction type, neither of which are explained on the Wizard component page (though there is an example that uses the CustomWizardNavFunction)

We want to wait until the new docs framework can implement a way to auto-add Type documentation, at which point these updates should be made to align with the new docs framework. This issue should cover adding Type documentation for all components, not just Wizard.

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 Wizard 组件页面和 pull request #9709 中的讨论开始,尤其关注 WizardNavType 和 CustomWizardNavFunction 示例。首先查看新文档框架计划提供的 Type 文档支持;当所有组件的类型都以与该框架一致的方式完成文档化时,即可视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
react, typescript
领域
documentation
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
28/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。