material-web icon indicating copy to clipboard operation
material-web copied to clipboard

Documentation for Icon component missing on material-web.dev

Open gschulze opened this issue 1 year ago • 4 comments

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

gschulze avatar Nov 20 '23 16:11 gschulze

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?

asyncLiz avatar Nov 20 '23 18:11 asyncLiz

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?

gschulze avatar Nov 20 '23 18:11 gschulze

Thank you!

asyncLiz avatar Nov 20 '23 18:11 asyncLiz

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.

datvm avatar Nov 21 '23 17:11 datvm