Add descriptions to each component page
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 138
- Forks
- 113
- PR merge metrics
- No merged PRs in 30d
Description
Currently our component pages just have the demos, so there's no description of the widget. That's pretty bad for search engine previews.
For example, the preview for googling "jquery progressbar" has the progressbar as the first result, but this as the description: "jQuery: The Write Less, Do More, JavaScript Library. ... Default determinate progress bar. view source. 1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14. 15. 16. 17. 18. 19 ..."
"jquery tooltip" doesn't gives us the tooltip widget as the first result, the description there is just "jQuery: The Write Less, Do More, JavaScript Library." (btw. I've updated my tooltip plugin's page to get rid of the spanish description and added a link to jqueryui.com/tooltip).
As for texts, we can probably use the description we have inside the manifest files for each plugin. That should be a good starting point.
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 by locating the component page templates and the manifest files that already contain plugin descriptions. Check how page descriptions are currently generated, then use the manifest text for each component and verify that search-engine previews expose the widget description rather than only demo content.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html, jquery
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100