Docs: First batch of explanation, tutorials, and how-tos#20
Merged
Docs: First batch of explanation, tutorials, and how-tos#20
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR sets up an initial MkDocs + Read the Docs documentation site for LambdaCron and adds the first batch of explanation and how-to content, along with diagrams and supporting doc build dependencies.
Changes:
- Add MkDocs configuration (Material theme) and Read the Docs build config.
- Add initial docs pages for architecture/data flow/lambda image modules and operational how-tos (SES, email notifications, test URL, writing lambdas/templates).
- Update dev dependencies/lockfile to include MkDocs (pinned
<2) and mkdocs-material.
Reviewed changes
Copilot reviewed 14 out of 18 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Add MkDocs + Material theme to dev extras. |
| pixi.lock | Lockfile updates to include MkDocs/Material and transitive deps. |
| modules/email-notification/setting-up-ses.md | Remove old SES setup doc (replaced by new docs site content). |
| mkdocs.yml | New MkDocs site configuration and navigation. |
| docs/index.md | New docs homepage/landing page. |
| docs/image-dev/AWSArchitecture.drawio | Add editable source diagrams (draw.io). |
| docs/how-to/write-lambda-and-templates.md | New how-to for authoring tasks + Jinja templates. |
| docs/how-to/use-test-url.md | New how-to for using the Lambda Function URL for testing. |
| docs/how-to/use-email-notifications.md | New how-to for wiring SES email notifications module. |
| docs/how-to/set-up-ses.md | New SES prerequisite/setup checklist page. |
| docs/explanation/lambda-architecture.md | New explanation of Lambda container image module patterns. |
| docs/explanation/data-flow.md | New explanation of _perform_task → SNS/SQS → template rendering data flow. |
| docs/explanation/architecture.md | New high-level architecture explanation with diagrams. |
| docs/explanation/AWSArchitecture-ModuleArchitecture.drawio.svg | Add generated diagram asset used by explanation pages. |
| AGENTS.md | Document Diataxis + MkDocs conventions for future doc contributions. |
| .readthedocs.yaml | Configure RTD to build MkDocs site from mkdocs.yml. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
ethanholz
approved these changes
Feb 25, 2026
Contributor
ethanholz
left a comment
There was a problem hiding this comment.
This looks good, my only criticism is hosting on RTD instead of on our own domain. That opinion is loosely held so no use blocking this PR. Merging.
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
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.
Tutorial: Your first LambdaCronI consider this to be the bare minimum we need for the docs; that's the goal for this PR.
EDIT: Holding off on the tutorial until we have a template repo set up for that.