carbon-design-system / carbon-design-system/carbon-components-angular
Documentation improvement tracking
- Dominant language
- TypeScript
- Stars
- 566
- Forks
- 318
- PR merge metrics
- No merged PRs in 30d
Description
Issue to track improvements that can be made to the documentation
- [ ] TableModel headers and columns must be equal length (otherwise unexpected behavior occurs) (code docs) @zvonimirfras
- [ ] upgrade guides should be visibly linked in more places (storybook)
- [ ] dropdown appendInline/ToBody behavior and examples (storybook + code docs)
- [ ] icons-angular usage (link out to that readme)
- [ ] tooltip placement and control (storybook + code docs) @HYACCCINT
- [ ] completely custom tooltip examples (storybook)
- [ ] custom modal usage patterns (storybook)
- [ ] state management with tabs (active tabs, saving-restoring state, generating tabs) (storybook)
- [ ] forms and modals (storybook)
- [x] modal data passing (storybook) @Donisius
- [ ] UI Shell ... just all of it (code docs)
- [ ] boolean attribute weirdness (`[expanded]="false"` isn't the same as `expanded="false"`) (code docs) @cal-smith
- [ ] complex layouts with grid and components like Tile (storybook)
- [ ] accessible tabs (storybook)
- [ ] accessible form controls (storybook)
- [ ] time picker usage patterns (single, multiple, ngModel, etc) (storybook)
- [ ] date picker patterns (single, multiple, ngModel, etc) (storybook)
- [ ] Observable items in dropdowns (and patterns around updating dropdown items) (code docs + storybook)
- [ ] patterns around searching (handling `enter`, ngModel/valueChange, clearing, etc) (storybook)
- [x] modal sizing (storybook)
- [ ] tabs as navigation (storybook) @sophiiae
- [ ] pagination + table + header patterns (storybook)
Contributor guide
Research direction
No specific file or test is named. Choose one unchecked topic, then review the relevant Storybook examples and code documentation; the work is done when that topic's stated usage, behavior, or accessibility guidance is documented and the checklist item can be marked complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- angular, storybook, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100