Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs-bug(icon): MatIcon appears in the Directives section #24093

Closed
dev054 opened this issue Dec 12, 2021 · 6 comments · Fixed by #30661
Closed

docs-bug(icon): MatIcon appears in the Directives section #24093

dev054 opened this issue Dec 12, 2021 · 6 comments · Fixed by #30661
Labels
area: dgeni Issue related to API docs extraction area: material.angular.io docs This issue is related to documentation P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent

Comments

@dev054
Copy link

dev054 commented Dec 12, 2021

Documentation Feedback

Currently the MatIcon appears in the Directives section, however it's a Component:

MatIcon in Directives

Affected documentation page

https://material.angular.io/components/icon/api
@dev054 dev054 added docs This issue is related to documentation needs triage This issue needs to be triaged by the team labels Dec 12, 2021
@dev054
Copy link
Author

dev054 commented Dec 12, 2021

Oh, I just noticed it's happening on all pages, not just for the MatIcon, so now I'm starting to wonder if this is on purpose 🤔

@dev054 dev054 changed the title docs-bug(icon): MatIcons appears as Directive docs-bug(icon): MatIcon appears in the Directives section Dec 12, 2021
@crisbeto
Copy link
Member

It's a bit of trivia from the Angular.js days, but every component is also a directive.

@dev054
Copy link
Author

dev054 commented Dec 16, 2021 •
edited
Loading

Yes, I'm aware that a component is, under the hood, a directive, but shouldn't the Material docs differentiate them, like the Angular docs?

@crisbeto crisbeto added area: dgeni Issue related to API docs extraction area: material.angular.io P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent and removed needs triage This issue needs to be triaged by the team labels Dec 20, 2021
@mistrykaran91
Copy link
Contributor

@crisbeto : I have created MR for autocomplete just to be sure whether its a correct approach and if that's the case then I can create another MR updating all the other components.

angular/material2-docs-content#26

@crisbeto
Copy link
Member

@mistrykaran91 the content in that repo is generated from source code. Your change will be overwritten next time we merge a PR.

@mistrykaran91
Copy link
Contributor

mistrykaran91 commented Mar 19, 2025 •
edited
Loading

My bad. I believe the dgeni project is what is used to create those documents. I can make the necessary adjustments.

mistrykaran91 added a commit to mistrykaran91/components that referenced this issue Mar 19, 2025
@mistrykaran91
refactor(dgeni): streamline directive and component metadata handling
3ec0117 
Currently, docs is not grouped based on Components and Directives. This fix will separate those two sections.

Fixes angular#24093
@mistrykaran91 mistrykaran91 mentioned this issue Mar 19, 2025
Closed
mistrykaran91 added a commit to mistrykaran91/components that referenced this issue Mar 19, 2025
@mistrykaran91
refactor(dgeni): streamline directive and component metadata handling
2f88803 
Currently, docs is not grouped based on Components and Directives. This fix will separate those two sections.

Fixes angular#24093
mistrykaran91 added a commit to mistrykaran91/components that referenced this issue Mar 19, 2025
@mistrykaran91
refactor(material-angular-io): streamline directive and component met…
9d8661f 
…adata handling in dgeni

Currently, docs is not grouped based on Components and Directives. This fix will separate those two sections.

Fixes angular#24093
mistrykaran91 added a commit to mistrykaran91/components that referenced this issue Mar 19, 2025
@mistrykaran91
fix(material-angular-io): streamline directive and component metadata…
4cd30e3 
… handling in dgeni

Currently, docs is not grouped based on Components and Directives. This fix will separate those two sections.

Fixes angular#24093
mistrykaran91 added a commit to mistrykaran91/components that referenced this issue Mar 19, 2025
@mistrykaran91
fix(material-angular-io): streamline directive and component metadata…
5c193b8 
… handling in dgeni

Currently, docs is not grouped based on Components and Directives. This fix will separate those two sections.

Fixes angular#24093
@mistrykaran91 mistrykaran91 mentioned this issue Mar 19, 2025
Merged
mistrykaran91 added a commit to mistrykaran91/components that referenced this issue Mar 20, 2025
@mistrykaran91
docs-bug(material-angular-io): streamline directive and component met…
e9a85dc 
…adata handling in dgeni

Currently, docs is not grouped based on Components and Directives. This fix will separate those two sections.

Fixes angular#24093
mistrykaran91 added a commit to mistrykaran91/components that referenced this issue Mar 20, 2025
@mistrykaran91
docs-bug(material.angular.io): streamline directive and component met…
dd2f276 
…adata handling in dgeni

Currently, docs is not grouped based on Components and Directives. This fix will separate those two sections.

Fixes angular#24093
mistrykaran91 added a commit to mistrykaran91/components that referenced this issue Mar 20, 2025
@mistrykaran91
fix(material.angular.io): streamline directive and component metadata…
573efbe 
… handling in dgeni

Currently, docs is not grouped based on Components and Directives. This fix will separate those two sections.

Fixes angular#24093
mistrykaran91 added a commit to mistrykaran91/components that referenced this issue Mar 20, 2025
@mistrykaran91
fix(material-angular-io): streamline directive and component metadata…
4f56add 
… handling in dgeni

Currently, docs is not grouped based on Components and Directives. This fix will separate those two sections.

Fixes angular#24093
mistrykaran91 added a commit to mistrykaran91/components that referenced this issue Mar 29, 2025
@mistrykaran91
fix(material-angular-io): streamline directive and component metadata…
8cd3206 
… handling in dgeni

Currently, docs is not grouped based on Components and Directives. This fix will separate those two sections.

Fixes angular#24093
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area: dgeni Issue related to API docs extraction area: material.angular.io docs This issue is related to documentation P3 An issue that is relevant to core functions, but does not impede progress. Important, but not urgent
Projects
None yet
Milestone
No milestone
3 participants
@crisbeto @mistrykaran91 @dev054