react-component / react-component/menu
Insufficient and confusing documentation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 701
- Forks
- 266
- Avg merge
- 4d 11h
- Merged PRs (30d)
- 3
Description
Hi,
This component seems really useful, but the documentation is very scarce and it's making it hard for me to properly use it.
The examples are good but missing pieces, and I'm unsure as to what some of the props for Menu do.
Maybe consider expanding it? It's a suggestion, of course not a demand of any kind.
Contributor guide
No contributing guide indexed for this repository
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 by reviewing the existing Menu examples and the current prop documentation. Identify the missing usage pieces and unclear props, then expand the documentation with concrete examples and explanations. Done means a newcomer can understand the relevant Menu props and use the component from the examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100