Skip to content
This repository has been archived by the owner on Mar 27, 2023. It is now read-only.

Where is the documentation for angular components? #103

Closed
demus opened this issue Nov 18, 2016 · 7 comments
Closed

Where is the documentation for angular components? #103

demus opened this issue Nov 18, 2016 · 7 comments
Assignees
Labels
type: support Support, implementation or questions type: website

Comments

@demus
Copy link

demus commented Nov 18, 2016

I don't see the documentation for angular components anywhere; am I missing something here?

I would also expect the full source code for each example to be available like most other component libraries.

BTW, a gitter would be nice for general usage questions.

@jaffoneh jaffoneh added type: support Support, implementation or questions type: website labels Nov 18, 2016
@jaffoneh jaffoneh self-assigned this Nov 18, 2016
@jaffoneh
Copy link
Contributor

@sdemurjian depending on the component you're looking for, the Angular documentation is there in that component's page. For example: if you go to dropdowns you can see that part of the component is built on top of Angular (or that dropdown is an Angular 2 component)

screen shot 2016-11-18 at 7 05 51 am

and then right there in the page you can get the HTML/CSS documentation then the Angular Component documentation (there is a heading called "Angular Component" in there).

https://vmware.github.io/clarity/documentation/dropdowns

I'd love to know more about your experience or why were you not able to find the documentation. Part of our goal is to improve our documentation as we go so we appreciate the feedback!

@demus
Copy link
Author

demus commented Nov 18, 2016

Thanks for the quick reply. The issue I was having is that for example the header page does not have [clr-nav-level] or even the components like <clr-header> listed. I was only aware the components existed from looking through the source code.

https://vmware.github.io/clarity/documentation/header

@adibwoy
Copy link
Contributor

adibwoy commented Nov 18, 2016

@sdemurjian: The responsive navigation is documented on this page: https://vmware.github.io/clarity/documentation/navigation under the Responsive Navigation section since it involves using both <clr-main-container> and <clr-header> with clr-nav-level. I will get this feedback on finding the docs for responsive navigation back to the team to check how we can document this better so that its easier to find.

@demus
Copy link
Author

demus commented Nov 18, 2016

@adityarb88 Oops, I definitely missed that section. Sorry about that!

@jaffoneh
Copy link
Contributor

Pinging @gachappell to make sure we take this into account in our documentation. Closing this bug based on the previous comment!

@gdm85
Copy link

gdm85 commented May 12, 2019

Those icons do not exist anymore in current documentation pages. Is there a new Angular documentation page?

@hippee-lee
Copy link
Contributor

@gdm85 - this is a very old issue. The website and documentation has changes since then.
If there is an issue with the current documentation or website please open a new issue.

@vmware-archive vmware-archive locked as resolved and limited conversation to collaborators May 13, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: support Support, implementation or questions type: website
Projects
None yet
Development

No branches or pull requests

5 participants