Skip to content

Conversation

@fuguiKz
Copy link
Contributor

@fuguiKz fuguiKz commented Dec 18, 2025

Issue number: #1005, #1006

Summary

Changes

  • Extracted the inline C# examples from docs/utilities/batch-processing.md into snippet files under examples/BatchProcessing/snippets/ and replaced the Markdown code fences with pymdownx.snippets includes.
  • Extracted the inline C# examples from docs/utilities/idempotency.md into snippet files under examples/Idempotency/snippets/ and replaced the Markdown code fences with pymdownx.snippets includes.
  • Enabled pymdownx.snippets.dedent_subsections in mkdocs.yml to preserve formatting when including indented subsections (e.g., within tabs/admonitions).

User experience

No intended visual changes to the rendered documentation; this is a maintainability improvement to avoid duplicated/inline code blocks.

Checklist

  • I have performed a self-review of this change
  • Changes have been tested (make build-docs-website)
  • Changes are documented

Fixes #1005
Fixes #1006

@boring-cyborg
Copy link

boring-cyborg bot commented Dec 18, 2025

Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need.
In the meantime, check out the #dotnet channel on our Powertools for AWS Lambda Discord: Invite link

@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Dec 18, 2025
@pull-request-size pull-request-size bot added the size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. label Dec 18, 2025
@hjgraca
Copy link
Contributor

hjgraca commented Dec 18, 2025

Hi @fuguiKz thanks for opening the pull request and working on this. Due to the current holiday period we might take more time to review your pull request. Thank you once again

@fuguiKz
Copy link
Contributor Author

fuguiKz commented Dec 19, 2025

Pushed a follow-up commit adding named namespaces to the new snippet files (Sonar rule S3903: types in global namespace). This should bring the SonarCloud Quality Gate back to green once checks rerun.

@fuguiKz
Copy link
Contributor Author

fuguiKz commented Dec 19, 2025

Update: SonarCloud checks are now green on the latest commit (SonarCloud Code Analysis is passing). Thanks!

@fuguiKz
Copy link
Contributor Author

fuguiKz commented Jan 1, 2026

FYI the GitHub Actions check suite is in an "action required" state (fork workflow approval), so Actions jobs haven't run yet. Other checks (SonarCloud, etc.) are green.

Could a maintainer approve and run the GitHub Actions workflows for this PR? That should unblock mergeability.

@hjgraca hjgraca assigned hjgraca and unassigned hjgraca Jan 6, 2026
- Move batch processing snippets from examples/BatchProcessing/snippets to docs/snippets/batch
- Move idempotency snippets from examples/Idempotency/snippets to docs/snippets/idempotency
- Update documentation references in batch-processing.md to point to new snippet locations
- Update documentation references in idempotency.md to point to new snippet locations
- Consolidate code examples in centralized docs directory for easier maintenance and access
@sonarqubecloud
Copy link

sonarqubecloud bot commented Jan 6, 2026

@hjgraca
Copy link
Contributor

hjgraca commented Jan 6, 2026

Hi @fuguiKz thank you so much for your work on this pull request. I just did an update to move the files to the docs/snippets/ folder instead of the examples folder (examples folder is for full examples).
I am very happy with your work and we will be merging and deploying this changes very soon. If you are happy to continue with the other utilities docs we will be very happy.

@hjgraca hjgraca merged commit 6b9e190 into aws-powertools:develop Jan 6, 2026
4 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented Jan 6, 2026

Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Extract inline code examples from Idempotency to examples folder Docs: Extract inline code examples from BatchProcessing to examples folder

3 participants