powertools-lambda-dotnet icon indicating copy to clipboard operation
powertools-lambda-dotnet copied to clipboard

Docs: Extract inline code examples from Idempotency to examples folder

Open leandrodamascena opened this issue 3 months ago • 1 comments

What were you searching in the docs?

Th file idempotency.md contains inline code examples that need to be extracted to separate files

Is this related to an existing documentation section?

Yes - docs/utilities/idempotency.md

How can we improve?

Extract inline code examples from idempotency.md to examples/idempotency/ folder.

Steps to contribute:

  1. Create folder structure: examples/idempotency/

  2. Extract code examples to .cs files using these naming patterns:

  • GettingStartedBasic.cs - Basic idempotency setup
  • CustomIdempotencyKey.cs - Custom key configuration
  • PayloadValidation.cs - Payload validation examples
  • ExpirationSettings.cs - TTL and expiration handling
  • DynamoDbConfiguration.cs - DynamoDB persistence layer
  • AdvancedConfiguration.cs - Advanced configuration options
  1. Check out this file for complete examples on how to add references to the .md file - https://raw.githubusercontent.com/aws-powertools/powertools-lambda-python/refs/heads/develop/docs/utilities/batch.md

  2. Ensure each .cs file:

  • Has proper using statements
  • Includes complete, runnable code
  • Has meaningful class/method names
  • Contains inline comments explaining key concepts

Got a suggestion in mind?

Use PascalCase for filenames and descriptive prefixes (GettingStarted, Custom, Advanced)

Acknowledgment

  • [x] I understand the final update might be different from my proposed suggestion, or refused.

leandrodamascena avatar Sep 29 '25 10:09 leandrodamascena

This is a great task for first-time contributors! 🚀

The work involves:

  • Moving code from documentation to separate files
  • Following clear naming conventions
  • Creating proper folder structure
  • No complex coding required - just organizing existing examples.

Want to contribute? Ping us in this issue and we'll help guide you through the process!

leandrodamascena avatar Sep 29 '25 10:09 leandrodamascena