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: Update README and examples/ #184

Open
bestickley opened this issue Dec 12, 2023 · 0 comments · May be fixed by #202
Open

Docs: Update README and examples/ #184

bestickley opened this issue Dec 12, 2023 · 0 comments · May be fixed by #202
Milestone

Comments

@bestickley
Copy link
Contributor

I think the README for this project could use some cleaning up/simplifying. I think it would be also helpful to copy Open Next's architecture diagram into the README so first time users can understand what they're getting from an infra perspective. Additionally I think we should focus more on OpenNext. This construct didn't start out on OpenNext, so I think some docs are older.

I'd also like to update the examples/ to be 1 CDK app with different stacks for each type of example. There is no need to have separate CDK apps for each example. This will simplify updating dependencies too. Using this issue to track work.

@bestickley bestickley added this to the v4 milestone Dec 15, 2023
@bestickley bestickley linked a pull request Feb 7, 2024 that will close this issue
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 a pull request may close this issue.

1 participant