Adding note in quickstart docs section about TypeScript deployments#243
Open
cesaraugustogarcia wants to merge 1 commit intoawslabs:mainfrom
Open
Adding note in quickstart docs section about TypeScript deployments#243cesaraugustogarcia wants to merge 1 commit intoawslabs:mainfrom
cesaraugustogarcia wants to merge 1 commit intoawslabs:mainfrom
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Added a note in the "Get Started" part of the Quickstart section about the
esbuildpackage that may be required for CDK deployments.Changes
Docs added to simply recommend a solution for TypeScript CDK installations.
User experience
Our CDK deployments in a personal project, having
"multi-agent-orchestrator": "^0.1.3"as dependency, failed with an unclear reason. After investigation we found out that addingesbuilddependency in the package.json was the solution.So I believe is a good idea to add a note on the installation section of documentation to help users avoid this friction.
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number:
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.