search

akveo / nebular

:boom: Customizable Angular UI Library based on Eva Design System :new_moon_with_face::sparkles:Dark Mode
https://akveo.github.io/nebular
MIT License
8.06k stars 1.51k forks source link

Ngx-admin documentation for nebular #1264

Open Mr-Sloth opened 5 years ago

Mr-Sloth commented 5 years ago

Issue type

I'm submitting a ... (check one with "x")

Issue description

Current behavior: Couldn´t find documentation of components from ngx-admin website. For example, I googled for the ngx-documentation and got to the website. The documentation is only about the installation process. I couldn´t find any forwarding to the detailed documentation only via github. Eventually, I just oversaw it.

Expected behavior: There should be a link to the nebular documentation at least inside of the ngx-documentation. As an example on the feature list. https://akveo.github.io/ngx-admin/docs/getting-started/what-is-ngxadmin -> Something like, "Ngx-Admin is based on Nebular, you can find further Documentation about the functions under this link." https://akveo.github.io/nebular/docs/getting-started/what-is-nebular#what-is-nebular

aefox commented 5 years ago

There is actually a mention on the frameworks that ngx-admin is built on.

image

Isn't that enough?

PS: I've been following on the development around nebular and ngx-admin closely for about a year now and the ngx-admin docs part is relatively new. The link in the docs will probably be added at some point