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(effects): update examples to standalone api #4522

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

AdrianRomanski
Copy link

@AdrianRomanski AdrianRomanski commented Sep 11, 2024

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 #4468

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

Copy link

netlify bot commented Sep 11, 2024

Deploy Preview for ngrx-io ready!

Name Link
🔨 Latest commit 4cb509a
🔍 Latest deploy log https://app.netlify.com/sites/ngrx-io/deploys/6747673ffdc3e100088bea74
😎 Deploy Preview https://deploy-preview-4522--ngrx-io.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

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.

Thanks for your work on this @AdrianRomanski
For next time, also try to add the issue number into the PR template (I've updated it now)

@@ -229,31 +242,6 @@ It's recommended to inject all dependencies as effect function arguments for eas

## Registering Root Effects

After you've written class-based or functional effects, you must register them so the effects start running. To register root-level effects, add the `EffectsModule.forRoot()` method with an array or sequence of effects classes and/or functional effects dictionaries to your `AppModule`.
Copy link
Member

Choose a reason for hiding this comment

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

projects/ngrx.io/content/guide/effects/index.md Outdated Show resolved Hide resolved
projects/ngrx.io/content/guide/effects/lifecycle.md Outdated Show resolved Hide resolved
@AdrianRomanski
Copy link
Author

@ timdeschryver

i pushed first changes :) Tommorrow i will do the remaining

@timdeschryver
Copy link
Member

@AdrianRomanski are you willing to address the remaining feedback?

@AdrianRomanski
Copy link
Author

@timdeschryver yes, i will sit to this straight after the office

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.

There are some syntax errors, and the sections also contain references to modules.
Because I can't references as comments, I will push a few commits to resolve this.

projects/ngrx.io/content/guide/effects/index.md Outdated Show resolved Hide resolved
projects/ngrx.io/content/guide/effects/index.md Outdated Show resolved Hide resolved
projects/ngrx.io/content/guide/effects/index.md Outdated Show resolved Hide resolved
projects/ngrx.io/content/guide/effects/index.md Outdated Show resolved Hide resolved
projects/ngrx.io/content/guide/effects/index.md Outdated Show resolved Hide resolved
projects/ngrx.io/content/guide/effects/index.md Outdated Show resolved Hide resolved
projects/ngrx.io/content/guide/effects/index.md Outdated Show resolved Hide resolved
projects/ngrx.io/content/guide/effects/index.md Outdated Show resolved Hide resolved
projects/ngrx.io/content/guide/effects/index.md Outdated Show resolved Hide resolved
projects/ngrx.io/content/guide/effects/index.md Outdated Show resolved Hide resolved
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.

@ngrx/effects: Update examples to standalone APIs
2 participants