🗄️ Docs report
Description
The Getting Started documentation states "IMPORTANT: Scully requires the router to be present in your application, don't forget to add it.", but this statement is given too late in the instructions steps.
When the user generates a new module for routing, this HAS to be named app-routing AND must be next to the app.module.
Default however, the command ng g m app-routing generates a new folder for the routes. If the user plans to implement Guards on the routes, a subfolder is not a bad place for this. Or the user might choose a different naming scheme, which is also not clear from the documentation instructions.
So everything can be wired up perfectly by the user, but chooses a different name and or location, scully still gives the error:
Couldn't find a route declaration in src/app/app.module.ts. when running the command ng g @scullyio/init:blog
🔬 Minimal Reproduction
Reproduction Steps**
ng new my-scully-app and do NOT choose to add angular routing.
even when added later on in a seperate module, the name MUST be app-routing and in the same folder as app.module.
Expected vs Actual Behavior**
Update the documentation to have the Angular CLI generate the app-routing module.
🗄️ Docs report
Description
The Getting Started documentation states "IMPORTANT: Scully requires the router to be present in your application, don't forget to add it.", but this statement is given too late in the instructions steps.
When the user generates a new module for routing, this HAS to be named app-routing AND must be next to the app.module.
Default however, the command
ng g m app-routinggenerates a new folder for the routes. If the user plans to implement Guards on the routes, a subfolder is not a bad place for this. Or the user might choose a different naming scheme, which is also not clear from the documentation instructions.So everything can be wired up perfectly by the user, but chooses a different name and or location, scully still gives the error:
Couldn't find a route declaration in src/app/app.module.ts.when running the commandng g @scullyio/init:blog🔬 Minimal Reproduction
Reproduction Steps**
ng new my-scully-appand do NOT choose to add angular routing.even when added later on in a seperate module, the name MUST be app-routing and in the same folder as app.module.
Expected vs Actual Behavior**
Update the documentation to have the Angular CLI generate the app-routing module.