-
Notifications
You must be signed in to change notification settings - Fork 161
Closed
Labels
completedThis item is complete and has been merged/shippedThis item is complete and has been merged/shippeddocumentationImprovements or additions to documentationImprovements or additions to documentationgood-first-issueSomething that is suitable for those who want to start contributingSomething that is suitable for those who want to start contributing
Description
Description of the improvement
Summary of the proposal
Code examples should be extracted to allow for validation / linting to help prevent errors.
How, where did you look for information
See
- Papercuts priorization before we consider v2 powertools-lambda-python#1009
- Docs: Move code snippets into dedicated python files add formatting and linting, fixing any outstanding errors powertools-lambda-python#1064
Missing or unclear documentation
Improvement
- Extract examples into the
docs/
folder, to allow for mkdocs to automatically pick it up - Add autoformatter and linting against these examples
- See python pr as an example: fix(docs): extract code snippets into dedicated python files and fix examples powertools-lambda-python#1065
Related existing documentation
Related issues, RFCs
Example of documentation examples with errors in them:
Metadata
Metadata
Assignees
Labels
completedThis item is complete and has been merged/shippedThis item is complete and has been merged/shippeddocumentationImprovements or additions to documentationImprovements or additions to documentationgood-first-issueSomething that is suitable for those who want to start contributingSomething that is suitable for those who want to start contributing