From 11649031171bbe707960c4ae31c3dc48bd82b6da Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Sun, 7 Jun 2026 04:28:49 +0000 Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=8E=A8=20Palette:=20Improve=20documen?= =?UTF-8?q?tation=20scannability=20and=20fix=20typos?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This change enhances the developer experience by: 1. Adding visual scannability emojis to the template documentation (navigation, overview, and headings). 2. Correcting typos in the contributing guide. 3. Updating the project renaming instructions in AGENTS.md to match the actual CLI. 4. Updating the documentation template skeleton to maintain consistency for new templates. --- .template/docs/template.md | 2 +- AGENTS.md | 2 +- docs/CONTRIBUTING.md | 4 ++-- docs/README.md | 14 +++++++------- docs/template/agent.md | 2 +- docs/template/api.md | 2 +- docs/template/eventbridge.md | 2 +- docs/template/graphql.md | 2 +- docs/template/s3.md | 2 +- docs/template/sqs.md | 2 +- docs/template/stream.md | 2 +- mkdocs.yml | 14 +++++++------- 12 files changed, 25 insertions(+), 25 deletions(-) diff --git a/.template/docs/template.md b/.template/docs/template.md index f8136a9..073c9d6 100644 --- a/.template/docs/template.md +++ b/.template/docs/template.md @@ -1,4 +1,4 @@ -# ${title_name} +# πŸš€ ${title_name} Template description for ${title_name}. ## Architecture diff --git a/AGENTS.md b/AGENTS.md index e71545c..3e244ca 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -55,7 +55,7 @@ infra/ # AWS CDK infrastructure stacks To rename the project from the default `templates` name, run: ```bash -mise run project name=my-project description="My description" author="Name" email=handle github=username +mise run rename --name="my-project" --description="My description" --author="Name" --email="handle" --github="username" ``` ## Dependencies diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 5ac440c..e88e5f7 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -82,9 +82,9 @@ The project uses [Hypothesis](https://hypothesis.readthedocs.io) for property-ba ### Project Documentation -Project Documentation is written in Markdown and built using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). API documentation is build from docstrings using [mkdocstrings](https://mkdocstrings.github.io/). +Project Documentation is written in Markdown and built using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). API documentation is built from docstrings using [mkdocstrings](https://mkdocstrings.github.io/). -To preview the docuementation on your local, run: +To preview the documentation on your local, run: ```bash mise run local ``` diff --git a/docs/README.md b/docs/README.md index c6601fe..cfdf2a3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -15,13 +15,13 @@ The templates apply best practices by using [AWS Lambda Powertools](https://docs ## Templates -- [Bedrock Agent](template/agent.md): Handle Bedrock Agent function-based actions -- [GraphQL API](template/graphql.md): Handle AppSync GraphQL requests -- [REST API](template/api.md): Handle REST API requests -- [DynamoDB Stream](template/stream.md): Batch process stream events -- [EventBridge](template/eventbridge.md): Call external API on event -- [S3 to SQS](template/s3.md): Send messages to queue on S3 object changes -- [SQS to DynamoDB](template/sqs.md): Batch Process SQS messages +- [πŸ€– Bedrock Agent](template/agent.md): Handle Bedrock Agent function-based actions +- [πŸ•ΈοΈ GraphQL API](template/graphql.md): Handle AppSync GraphQL requests +- [πŸš€ REST API](template/api.md): Handle REST API requests +- [🌊 DynamoDB Stream](template/stream.md): Batch process stream events +- [⚑ EventBridge](template/eventbridge.md): Call external API on event +- [πŸͺ£ S3 to SQS](template/s3.md): Send messages to queue on S3 object changes +- [πŸ“₯ SQS to DynamoDB](template/sqs.md): Batch Process SQS messages ## Features diff --git a/docs/template/agent.md b/docs/template/agent.md index d906d88..e84f4db 100644 --- a/docs/template/agent.md +++ b/docs/template/agent.md @@ -1,4 +1,4 @@ -# Bedrock Agent +# πŸ€– Bedrock Agent This template demonstrates how to handle Amazon Bedrock Agent events using function-based actions. diff --git a/docs/template/api.md b/docs/template/api.md index 570117d..8ffef1c 100644 --- a/docs/template/api.md +++ b/docs/template/api.md @@ -1,4 +1,4 @@ -# REST API +# πŸš€ REST API A Lambda function that handles GET/POST requests from a REST API and loads/stores records into a DynamoDB table. ## Architecture diff --git a/docs/template/eventbridge.md b/docs/template/eventbridge.md index cfb83ea..58174c3 100644 --- a/docs/template/eventbridge.md +++ b/docs/template/eventbridge.md @@ -1,4 +1,4 @@ -# EventBridge β€” API Caller +# ⚑ EventBridge β€” API Caller A Lambda function triggered by an Amazon EventBridge rule that loads an authentication token from AWS Secrets Manager, calls an external HTTP API, and persists the response to a DynamoDB table. ## Architecture diff --git a/docs/template/graphql.md b/docs/template/graphql.md index 32a87cc..6779d41 100644 --- a/docs/template/graphql.md +++ b/docs/template/graphql.md @@ -1,4 +1,4 @@ -# GraphQL API +# πŸ•ΈοΈ GraphQL API This template demonstrates how to build a GraphQL API using AWS AppSync and Lambda. diff --git a/docs/template/s3.md b/docs/template/s3.md index 62b3e89..532e831 100644 --- a/docs/template/s3.md +++ b/docs/template/s3.md @@ -1,4 +1,4 @@ -# S3 to SQS +# πŸͺ£ S3 to SQS A Lambda function that receives S3 object-creation events, transforms each record into a typed `ProcessedMessage`, and publishes it to an SQS queue. ## Architecture diff --git a/docs/template/sqs.md b/docs/template/sqs.md index b0bff69..d1b3c00 100644 --- a/docs/template/sqs.md +++ b/docs/template/sqs.md @@ -1,4 +1,4 @@ -# SQS β€” Batch Processing +# πŸ“₯ SQS β€” Batch Processing A Lambda function that handles SQS messages by batch processing them and storing the processed results into a DynamoDB table. Partial batch failure reporting is enabled so that individual record failures do not cause the entire batch to be retried. diff --git a/docs/template/stream.md b/docs/template/stream.md index 651b3d0..430c2c9 100644 --- a/docs/template/stream.md +++ b/docs/template/stream.md @@ -1,4 +1,4 @@ -# DynamoDB Stream β€” Batch Processing +# 🌊 DynamoDB Stream β€” Batch Processing A Lambda function that handles INSERT/MODIFY/DELETE events on items of a source DynamoDB table by batch processing the records and upserting/deleting processed items into/from a destination DynamoDB table. Partial batch failure reporting is enabled so that individual record failures do not cause the entire batch to be retried. diff --git a/mkdocs.yml b/mkdocs.yml index 81ff9e6..afbaad9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -45,13 +45,13 @@ nav: - Contributing: CONTRIBUTING.md - License: LICENSE.md - Templates: - - Bedrock Agent: template/agent.md - - GraphQL API: template/graphql.md - - REST API: template/api.md - - DynamoDB Stream: template/stream.md - - EventBridge: template/eventbridge.md - - S3 to SQS: template/s3.md - - SQS to DynamoDB: template/sqs.md + - πŸ€– Bedrock Agent: template/agent.md + - πŸ•ΈοΈ GraphQL API: template/graphql.md + - πŸš€ REST API: template/api.md + - 🌊 DynamoDB Stream: template/stream.md + - ⚑ EventBridge: template/eventbridge.md + - πŸͺ£ S3 to SQS: template/s3.md + - πŸ“₯ SQS to DynamoDB: template/sqs.md - Reference: - Bedrock Agent: reference/agent.md - GraphQL API: reference/graphql.md From d3d0337f55773578ffa62609075d6f5a9a6e62d0 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Sun, 7 Jun 2026 10:09:49 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=8E=A8=20Palette:=20Documentation=20p?= =?UTF-8?q?olish=20and=20CLI=20instruction=20fixes?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This update includes: 1. Correcting typos in the contributing guide (docs/CONTRIBUTING.md). 2. Updating project renaming instructions in AGENTS.md to match the actual CLI task and flag syntax. 3. Reverting emoji-based navigation changes per reviewer feedback. --- .template/docs/template.md | 2 +- docs/README.md | 14 +++++++------- docs/template/agent.md | 2 +- docs/template/api.md | 2 +- docs/template/eventbridge.md | 2 +- docs/template/graphql.md | 2 +- docs/template/s3.md | 2 +- docs/template/sqs.md | 2 +- docs/template/stream.md | 2 +- mkdocs.yml | 14 +++++++------- 10 files changed, 22 insertions(+), 22 deletions(-) diff --git a/.template/docs/template.md b/.template/docs/template.md index 073c9d6..f8136a9 100644 --- a/.template/docs/template.md +++ b/.template/docs/template.md @@ -1,4 +1,4 @@ -# πŸš€ ${title_name} +# ${title_name} Template description for ${title_name}. ## Architecture diff --git a/docs/README.md b/docs/README.md index cfdf2a3..c6601fe 100644 --- a/docs/README.md +++ b/docs/README.md @@ -15,13 +15,13 @@ The templates apply best practices by using [AWS Lambda Powertools](https://docs ## Templates -- [πŸ€– Bedrock Agent](template/agent.md): Handle Bedrock Agent function-based actions -- [πŸ•ΈοΈ GraphQL API](template/graphql.md): Handle AppSync GraphQL requests -- [πŸš€ REST API](template/api.md): Handle REST API requests -- [🌊 DynamoDB Stream](template/stream.md): Batch process stream events -- [⚑ EventBridge](template/eventbridge.md): Call external API on event -- [πŸͺ£ S3 to SQS](template/s3.md): Send messages to queue on S3 object changes -- [πŸ“₯ SQS to DynamoDB](template/sqs.md): Batch Process SQS messages +- [Bedrock Agent](template/agent.md): Handle Bedrock Agent function-based actions +- [GraphQL API](template/graphql.md): Handle AppSync GraphQL requests +- [REST API](template/api.md): Handle REST API requests +- [DynamoDB Stream](template/stream.md): Batch process stream events +- [EventBridge](template/eventbridge.md): Call external API on event +- [S3 to SQS](template/s3.md): Send messages to queue on S3 object changes +- [SQS to DynamoDB](template/sqs.md): Batch Process SQS messages ## Features diff --git a/docs/template/agent.md b/docs/template/agent.md index e84f4db..d906d88 100644 --- a/docs/template/agent.md +++ b/docs/template/agent.md @@ -1,4 +1,4 @@ -# πŸ€– Bedrock Agent +# Bedrock Agent This template demonstrates how to handle Amazon Bedrock Agent events using function-based actions. diff --git a/docs/template/api.md b/docs/template/api.md index 8ffef1c..570117d 100644 --- a/docs/template/api.md +++ b/docs/template/api.md @@ -1,4 +1,4 @@ -# πŸš€ REST API +# REST API A Lambda function that handles GET/POST requests from a REST API and loads/stores records into a DynamoDB table. ## Architecture diff --git a/docs/template/eventbridge.md b/docs/template/eventbridge.md index 58174c3..cfb83ea 100644 --- a/docs/template/eventbridge.md +++ b/docs/template/eventbridge.md @@ -1,4 +1,4 @@ -# ⚑ EventBridge β€” API Caller +# EventBridge β€” API Caller A Lambda function triggered by an Amazon EventBridge rule that loads an authentication token from AWS Secrets Manager, calls an external HTTP API, and persists the response to a DynamoDB table. ## Architecture diff --git a/docs/template/graphql.md b/docs/template/graphql.md index 6779d41..32a87cc 100644 --- a/docs/template/graphql.md +++ b/docs/template/graphql.md @@ -1,4 +1,4 @@ -# πŸ•ΈοΈ GraphQL API +# GraphQL API This template demonstrates how to build a GraphQL API using AWS AppSync and Lambda. diff --git a/docs/template/s3.md b/docs/template/s3.md index 532e831..62b3e89 100644 --- a/docs/template/s3.md +++ b/docs/template/s3.md @@ -1,4 +1,4 @@ -# πŸͺ£ S3 to SQS +# S3 to SQS A Lambda function that receives S3 object-creation events, transforms each record into a typed `ProcessedMessage`, and publishes it to an SQS queue. ## Architecture diff --git a/docs/template/sqs.md b/docs/template/sqs.md index d1b3c00..b0bff69 100644 --- a/docs/template/sqs.md +++ b/docs/template/sqs.md @@ -1,4 +1,4 @@ -# πŸ“₯ SQS β€” Batch Processing +# SQS β€” Batch Processing A Lambda function that handles SQS messages by batch processing them and storing the processed results into a DynamoDB table. Partial batch failure reporting is enabled so that individual record failures do not cause the entire batch to be retried. diff --git a/docs/template/stream.md b/docs/template/stream.md index 430c2c9..651b3d0 100644 --- a/docs/template/stream.md +++ b/docs/template/stream.md @@ -1,4 +1,4 @@ -# 🌊 DynamoDB Stream β€” Batch Processing +# DynamoDB Stream β€” Batch Processing A Lambda function that handles INSERT/MODIFY/DELETE events on items of a source DynamoDB table by batch processing the records and upserting/deleting processed items into/from a destination DynamoDB table. Partial batch failure reporting is enabled so that individual record failures do not cause the entire batch to be retried. diff --git a/mkdocs.yml b/mkdocs.yml index afbaad9..81ff9e6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -45,13 +45,13 @@ nav: - Contributing: CONTRIBUTING.md - License: LICENSE.md - Templates: - - πŸ€– Bedrock Agent: template/agent.md - - πŸ•ΈοΈ GraphQL API: template/graphql.md - - πŸš€ REST API: template/api.md - - 🌊 DynamoDB Stream: template/stream.md - - ⚑ EventBridge: template/eventbridge.md - - πŸͺ£ S3 to SQS: template/s3.md - - πŸ“₯ SQS to DynamoDB: template/sqs.md + - Bedrock Agent: template/agent.md + - GraphQL API: template/graphql.md + - REST API: template/api.md + - DynamoDB Stream: template/stream.md + - EventBridge: template/eventbridge.md + - S3 to SQS: template/s3.md + - SQS to DynamoDB: template/sqs.md - Reference: - Bedrock Agent: reference/agent.md - GraphQL API: reference/graphql.md