docs: expand the development environment page (SAM, CDK, testing, agentic) - #231
Open
SilanHe wants to merge 20 commits into
Open
docs: expand the development environment page (SAM, CDK, testing, agentic)#231SilanHe wants to merge 20 commits into
SilanHe wants to merge 20 commits into
Conversation
Replaces the placeholder (a lone workflow diagram) with a full dev-env guide: - prerequisites and per-language SDK install (TS/Python/Java/C#) - the inner development loop and local testing (links to Testing section) - function configuration (DurableConfig, execution-role policy, qualified ARN) - deploy with infrastructure as code: SAM and CDK examples (+ CloudFormation note) - test against the cloud via the Cloud Runner and SAM CLI - agentic development with the team's Kiro Power, plus the steering files for other AI assistants Grounded in the repo's quickstart, testing pages, configuration reference, and the aws-lambda-durable-functions-power steering pack. mdformat + codespell clean. Closes #111
SilanHe
marked this pull request as draft
July 29, 2026 17:11
Adds a tabbed minimal test (TS/Python/Java/C#) to the 'Write and test locally' section via snippet includes to the existing verified examples/*/testing/authoring/ minimal-test.* files, so the code stays in sync and cannot drift.
yaythomas
reviewed
Jul 29, 2026
Drop the 'for the valid ranges and defaults' clause: the configuration reference does not currently document DurableConfig ranges/defaults (PR #229 was closed unmerged), so the page no longer promises content that isn't there.
Relabel the workflow flowchart nodes to match the page's H2 section titles (Install the SDK / Write and test locally / Configure your function / Deploy with infrastructure as code / Test against the cloud).
Rename the five workflow sections to the flowchart's step labels (Write Function / Write Tests / Run Tests / Deploy / Test in Cloud) and drop the node numbers so headings and flowchart labels match verbatim. SDK install folds into Write Function; DurableConfig requirements fold into Deploy.
Updated terminology for clarity and consistency in the development environment documentation. Adjusted explanations regarding the local development loop, Lambda runtime, and deployment recommendations.
Split the shared console block into TypeScript/Python/Java/C# tabs (npm test / pytest / mvn test / dotnet test).
- Rewrite the runtime-SDK-lag sentence (fix comma splice and 'it can unclear') - Replace the bare durable-configuration.html URL with a markdown link
Clarify SDK versioning and improve instructions for building workflows.
Updated recommendation for deploying with SAM or CDK to emphasize the importance of storing function configuration and related infrastructure in source control for better iteration and production readiness.
Add 1.-5. to both the flowchart step nodes and the matching workflow section headings so they stay in sync (1. Write Function ... 5. Test in Cloud).
- Intro + prerequisites: SAM CLI drives the local dev loop; CDK recommended for productionizing the surrounding infrastructure - Write Function: lead with 'sam init' (durable starter templates for TS/Python/Java), then keep the manual SDK add/pin tabs - Deploy: frame SAM as the iterate path and CDK as the productionize path (tab labels 'SAM (iterate)' / 'CDK (productionize)')
SilanHe
commented
Jul 29, 2026
- 'tight inner loop' -> 'tight local loop' (clarify inner == local) - 'use CloudFormation' -> 'use CloudFormation directly' (clarify vs SAM/CDK)
…tself) SAM does not keep config/IAM/version/alias in source control; it declares them in a single template.yaml that you can put under source control.
SilanHe
marked this pull request as ready for review
July 30, 2026 22:59
…ersion floor, input payload, TS build)
bchampp
requested changes
Jul 31, 2026
Co-authored-by: Brent Champion <brent.champion@queensu.ca>
…ableConfig nuance, retention default, SAM/CDK prod, local sam build/invoke)
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
4 participants
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.
What
Expands
docs/getting-started/development-environment.mdfrom a placeholder (a single workflow diagram) into a full development-environment guide, per #111. Sections:LocalDurableTestRunner/DurableFunctionTestRunner), linking into the Testing section rather than duplicating it.DurableConfig,AWSLambdaBasicDurableExecutionRolePolicy, qualified ARN) with a link to the configuration reference.sam local invoke/sam remote invoke).aws-lambda-durable-functions-power), how to install/activate it, and the steering files for other AI assistants; notes why durable functions suit agentic workloads.Grounding
Content is grounded in existing repo sources — the Quickstart, the Testing pages, the new configuration reference (#229), and the
aws-lambda-durable-functions-powersteering pack (README.md/POWER.md/deployment-iac.md/getting-started.md) — not invented. No SDK behavior is asserted beyond what those sources state.Quality
mdformat --checkandcodespellpass on the file, and it contains no hidden characters — so it satisfies the PR quality gate added in #230. Links point to existing pages.Closes #111