Improve documentation to ease the adoption

[leandrodamascena]

Summary

The current documentation for the aws-lambda-deploy action needs improvements regarding array configurations. Several properties that expect arrays to be JSON strings are missing explanation, making adoption a bit more difficult. For example, to learn how to configure logging-config, I had to go to the test file to understand the expected value.

The documentation currently suffers from:

• array formatting - Some properties should be YAML arrays, but since those are JSON strings, please document this
• Missing format specifications - no clear indication of which properties expect JSON strings vs native YAML
• Lack of real-world examples - need more examples covering more use cases
• Hidden configuration requirements - complex properties like logging-config, vpc-config, and image need better documentation

Missing Complete Examples

No comprehensive example showing:

• Multi-layer configuration with proper JSON string formatting
• Complete logging-config setup with all available options
• VPC configuration with subnets and security groups as JSON strings
• Dead letter queue configuration
• File system configuration for EFS mounts
• Image-based deployments with proper configuration

I have some ideas for improving the documentation structure and adding examples that would make this action easier for adoption. I'd be happy to contribute a pull request with examples, proper formatting guidelines, and complete configuration scenarios if that make sense.

[greyshi]

Hey Leo, thanks for the suggestions. The examples we have in the README are very basic. That's somewhat intentional to not scare users away, but I think adding a more complex examples that includes all of these structures which are not obvious would be a great addition. If you're up for making these changes like you mentioned that would be much appreciated.

[leandrodamascena]

Hey Leo, thanks for the suggestions. The examples we have in the README are very basic. That's somewhat intentional to not scare users away, but I think adding a more complex examples that includes all of these structures which are not obvious would be a great addition. If you're up for making these changes like you mentioned that would be much appreciated.

Hey @greyshi, sure! Tomorrow I'll send a PR with some changes I have in mind and then we can iterate to merge them.

Thanks for accepting the suggestion.

[RobvH]

Might also be helpful to add a common Lambda@Edge case to an example. Updating / Deploying the lambda with this action, followed by the CLI commands to deploy it in the CF distro.