Update all component taglines to follow same structure
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 79
- Forks
- 52
- Avg merge
- 18h 58m
- Merged PRs (30d)
- 4
Description
What component is this related to?
All components have taglines that are displayed in the page header on the component page, as well as being displayed on the component cards in the component gallery.
Why do we need it?
Currently, some taglines read as a usage guideline 'Use this components to do xyz' and others are descriptive of the component 'This component is a selection component that allows...'.
We need to align all taglines so that they follow the same structure to make it more consistent.
Suggestion is to make all taglines descriptive of the component, as usage guidance is found on the guidance page itself.
Related open issues
#718
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
Review the component page headers, component gallery cards, and their guidance pages, using related issue #718 for context. Compare all existing taglines and identify which follow usage guidance versus descriptive wording; done means every component tagline follows the same descriptive structure.
Written by the indexing model from the issue text.
Assessment
- Domain
- content
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100