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(newsletter): clean up formatting and verbiage of existing documentation #3002

Merged
merged 2 commits into from
Sep 20, 2024

Conversation

xelaint
Copy link
Member

@xelaint xelaint commented Aug 20, 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?

Part of: #2694

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@xelaint xelaint added package: newsletter @daffodil/newsletter status: awaiting review This PR is awaiting review labels Aug 20, 2024
@xelaint xelaint requested a review from griest024 August 20, 2024 15:29
@xelaint xelaint requested a review from a team as a code owner August 20, 2024 15:29
@xelaint
Copy link
Member Author

xelaint commented Aug 20, 2024

@griest024 there seemed to be some duplicating information so I tried my best to clean it up and remove what I thought was redundant information. Can you review and make sure I didn't remove important information?

libs/newsletter/README.md Outdated Show resolved Hide resolved
## Setting up your AppModule
Install with yarn:
```
yarn add @daffodil/newsletter @daffodil/core @ngrx/store @ngrx/effects
Copy link
Member

Choose a reason for hiding this comment

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

Remove extraneous packages.

Copy link
Member Author

Choose a reason for hiding this comment

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

removed

libs/newsletter/README.md Outdated Show resolved Hide resolved
libs/newsletter/README.md Outdated Show resolved Hide resolved
libs/newsletter/README.md Show resolved Hide resolved
@xelaint xelaint merged commit 0e92c31 into develop Sep 20, 2024
8 checks passed
@damienwebdev damienwebdev deleted the newsletter-docs-reformat branch October 18, 2024 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package: newsletter @daffodil/newsletter status: awaiting review This PR is awaiting review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants