Documentation for Icon component missing on material-web.dev

material-components / material-web

Material Design Web Components

https://material-web.dev

Apache License 2.0

9.23k stars 882 forks source link

Documentation for Icon component missing on material-web.dev #5206

Open gschulze opened 10 months ago

gschulze commented 10 months ago

Description

The documentation for Icon is not accessible from the table of contents, and the link from Icon Button documentation page points to https://material-web.dev/components/icon-button/icon/#usage, which does not exist. Instead, it should point to https://material-web.dev/components/icon/#usage.

Browser/OS Environment

No response

asyncLiz commented 10 months ago

I don't think the documentation is missing, are you reporting a bad link somewhere? If so, can you add a link to the source code for the docs that are incorrect?

gschulze commented 10 months ago

Hi, thanks for the quick reply. Here's the link to the source: https://github.com/material-components/material-web/blob/8eb1f30e6f65e2580231fbeee7d048ee90fb00b7/docs/components/icon-button.md?plain=1#L77

There are basically two issues:

The Icon component is not selectable from the table of contents on the left side
The link from the Icon Button component mentioned above points to the wrong location, assuming icons.md is nested within icon-buttons. I guess it should be top-level?

asyncLiz commented 10 months ago

Thank you!

datvm commented 10 months ago

https://material-web.dev/components/icon/ is available but it's not on the sidebar. I thought it's intentional because Elevation is not there as well. Interestingly Ripple wasn't there before but it's now.