docs(external-router): clarify README and getting started guides #4034
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
xelaint
requested changes
Sep 30, 2025
| > - Always include a fallback route at the end | ||
| > These components are also just examples, so you can replace them with whatever components you want. | ||
| ### Step 5: Use in Templates |
Member
There was a problem hiding this comment.
Suggested change
| ### Step 5: Use in Templates | |
| ### Use in templates |
| > | ||
| > - Static routes are evaluated first | ||
| > - External routes use `path: '**'` with `canMatch` guards | ||
| > - Order matters - more specific types should come first |
Member
There was a problem hiding this comment.
Suggested change
| > - Order matters - more specific types should come first | |
| > - Order matters—more specific types should come first |
| Add `provideExternalRouter` to the `providers` of your `appConfig` or `AppModule`. | ||
| This guide walks you through setting up `@daffodil/external-router` to enable dynamic route resolution from external systems in your Angular application. | ||
|
|
||
| ## Quick Start |
Member
There was a problem hiding this comment.
Suggested change
| ## Quick Start | |
| ## Quick start |
| npm install @daffodil/external-router --save | ||
| ``` | ||
|
|
||
| ### Basic Setup |
Member
There was a problem hiding this comment.
Suggested change
| ### Basic Setup | |
| ### Basic setup |
| ``` | ||
|
|
||
| ## Configurations | ||
| ### Configure a Driver |
Member
There was a problem hiding this comment.
Suggested change
| ### Configure a Driver | |
| ### Configure a driver |
|
|
||
| ```bash | ||
| npm install @daffodil/external-router --save | ||
| ``` |
Member
There was a problem hiding this comment.
Do we want to add installation instruction for yarn?
yarn add @daffodil/external-router| <li><a routerLink="/another-page">Other Type (another)</a></li> | ||
| </ul> | ||
| <router-outlet></router-outlet> | ||
| ## Advanced Configuration |
Member
There was a problem hiding this comment.
Suggested change
| ## Advanced Configuration | |
| ## Advanced configuration |
|
|
||
| See the [configuration guide](/libs/external-router/guides/configuration.md) for all available options. | ||
|
|
||
| ### Production Setup |
Member
There was a problem hiding this comment.
Should this be nested within ## Advanced configuration?
| ``` | ||
|
|
||
| 4. Serve your app. You can now navigate to `"/test-page"`, `"/other-page"`, and `"/another-page"` as if it was defined in your Angular routes. | ||
| ## Next Steps |
Member
There was a problem hiding this comment.
Suggested change
| ## Next Steps | |
| ## Next steps |
| yarn add @daffodil/external-router | ||
| ``` | ||
|
|
||
| ## Getting Started |
Member
There was a problem hiding this comment.
Suggested change
| ## Getting Started | |
| ## Getting started |
xelaint
added
status: needs response
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
PR Type
Current behavior
I tried to set up the external router driver by following the docs and I was a little confused, so I had to look at the code to remember how it worked.
Touches: #2683
New behavior
I rewrote the guide to be a little more clear on how to use the package.
Breaking change?
Additional context