acl-services / acl-services/paprika
InlineEditors documentation problems
- 主要語言
- JavaScript
- 星號
- 54
- 分支
- 10
- 平均合併
- 1 天 12 小時
- 30 天內合併 PR
- 6
描述
The docs of the new InlineEditors components need some work:
- [x] there should be a standard readme.md file with the prop table
- [ ] ~do we need these interactive examples in the docs, plus stories? it's twice the maintenance~
- [ ] ~in the ListBox example, rename 'someOptions' to 'subscriptions'~
- [ ] ~the 'textarea' example is broken (clicking it, screen goes white)~
- [x] the 'textarea' example has the wrong props
- [x] there's no 'textarea' story
- [x] rename 'with in a table' story to 'ListBox within a table'
貢獻指南
這個儲存庫沒有索引到貢獻指南
研究方向
首先定位 InlineEditors 的文件來源,包括 component readme.md 以及 ListBox/textarea story 檔案。檢查 prop 表格、story 名稱和 props 目前定義的位置,然後套用要求的更新:修正 textarea props/story 的存在性,並將表格 story 重新命名為 "ListBox within a table."。執行用於元件文件的專案 docs/storybook 預覽路徑,並確認更新後的 stories 能正常呈現,且缺少的 textarea story 已存在。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- javascript, react, storybook
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 2/5
- 預估耗時
- 1-3 小時
- 活躍度
- 停滯
- 描述清晰度
- 基本清楚
- 新手友好度
- 58/100