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.

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

NEED More DOCS !! 😅 #318

Open
1 of 3 tasks
tomavic opened this issue May 9, 2018 · 2 comments
Open
1 of 3 tasks

NEED More DOCS !! 😅 #318

tomavic opened this issue May 9, 2018 · 2 comments

Comments

@tomavic
Copy link

tomavic commented May 9, 2018

I'm submitting a...

  • Bug report
  • Feature request
  • Documentation issue or request

Current behavior

I am so impressed by this generator and the structure itself. Good job!
BUT need more explanation on WHY to use some modules that way ?

For Example: I am using Interceptor in my Ionic and Angular apps, but here it's kinda different than what I used to implement

Another Example: What the heck is the Shell module ? 🤣 I tried but didn't got what it should be used for !?

Expected behavior

More docs for CORE, Shared and Routing modules

Finally I need to take advantage of Angular Best practice and Style guide as well. With some simple modification from my side. that what any Developer would need

@sinedied
Copy link
Member

You are right, there should definitely be more docs! 😺
Unfortunately, this project is maintained by volunteers so documentation is a best effort... Though you can always help and contribute 😉
I'll try to put up a FAQ someday and add more to the Angular guide already provided.

Hope it helps!

@tomavic
Copy link
Author

tomavic commented May 11, 2018

Thanks @sinedied

I got the idea of shared and core modules, and that what exactly I was doing in all my Angular projects with little differences.

For the Shell module, I think it's kinda crucial. I had implemented the same idea but with React-Way. i tried ton implement the concept of containers with two main containers "Full" and "simple". The simple container is for pages like Login, Signup, 404, and so on. The Full container contains Navbar, Sidemenu, Asidemenu (if found), and main content of app <router-outlet></router-outlet>
This way I think it's easy to customise, or even add more containers later. Need your opinion in that

For Interceptor part, I got exactly what you did and for caching we will need more docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants