influxdata / influxdata/clockface
Improve Input (Checkbox) documentation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 46
- Forks
- 18
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 1
Description
https://influxdata.github.io/clockface/?path=/story/components-inputs-base--input-checkbox
Currently, this page is titled Input (Checkbox), but the example contains a radio button.
There are many ways this can be resolved so I don't want to dictate a solution, but if we want to keep a Checkbox page it should match the checkbox styles that are in the application.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Storybook Input Checkbox page and compare its example with the checkbox styles used in the application. Update the documentation so the page title and example are consistent, then verify the Storybook page no longer presents a radio button as a checkbox.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, storybook, typescript
- Domain
- documentation, frontend
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100