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

docs(router-store): add DefaultRouterStateSerializer #1900

Merged

Conversation

kanafghan
Copy link
Contributor

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Closes #1642

What is the new behavior?

Add documentation for the default router state serializer - https://github.com/ngrx/platform/blob/master/modules/router-store/src/serializers/default_serializer.ts to ngrx.io.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@ngrxbot
Copy link
Collaborator

ngrxbot commented May 30, 2019

Preview docs changes for b8aeb7a at https://previews.ngrx.io/pr1900-b8aeb7a/

@@ -0,0 +1,3 @@
# Default Router State Serializer
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't need a separate file. I think it should go above Custom Router State Serializer in the configuration doc

Copy link
Contributor Author

@kanafghan kanafghan May 31, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with you @brandonroberts. I have done so based on the following sentence from @timdeschryver on #1642. If you guys agree, I will change it accordingly.

This should be a page under Router Store

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, my bad 😅

@ngrxbot
Copy link
Collaborator

ngrxbot commented Jun 2, 2019

Preview docs changes for a1c1ee6 at https://previews.ngrx.io/pr1900-a1c1ee6/

Copy link
Member

@timdeschryver timdeschryver left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@brandonroberts brandonroberts merged commit 11a9819 into ngrx:master Jun 4, 2019
@kanafghan kanafghan deleted the docs-DefaultRouterStateSerializer branch June 6, 2019 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs(RouterStore): add DefaultRouterStateSerializer
4 participants