material-components / material-components/material-web
Existing documentation is missing at material-web.dev
Open
Nobody has claimed this yet.
- Dominant language
- SCSS
- Stars
- 11.3k
- Forks
- 1.1k
- Avg merge
- 20h 28m
- Merged PRs (30d)
- 13
Description
Description
I found that few documents from the /docs folder are missing at https://material-web.dev/:
- Elevation https://github.com/material-components/material-web/blob/main/docs/components/elevation.md
- Divider https://github.com/material-components/material-web/blob/main/docs/components/divider.md
- Focus ring https://github.com/material-components/material-web/blob/main/docs/components/focus-ring.md
- Icon https://github.com/material-components/material-web/blob/main/docs/components/icon.md
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 comparing the four named documents in docs/components—elevation.md, divider.md, focus-ring.md, and icon.md—with the pages currently published at material-web.dev. Trace how documentation from the /docs folder reaches the site, then confirm that all four pages are available and match the existing source content.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100