docs: add GitHub Pages landing page with MkDocs#203
Merged
Conversation
- Deleted `RELEASE_PROCESS.md` as it duplicates information in GitHub workflows. - Streamlined repository to ensure documentation remains concise and up-to-date.
- Added `docs/index.md` as the main entry point for MkDocs documentation. - Configured the project with `mkdocs.yml` using the Material theme. - Defined dependencies in `pyproject.toml` and added `uv.lock` for dependency locking.
- Updated `.gitignore` to exclude the `.claude/` directory.
- Added site metadata including description, author, and repository details. - Configured navigation structure with `Home: index.md`. - Enabled `search` plugin and specified files to watch for changes.
…tent - Fixed repository URL in MkDocs configuration. - Enabled advanced Material theme features like code copy, tabs, and footer navigation. - Added extensive Markdown and PyMdown extensions for enhanced content formatting. - Updated navigation structure, renaming "Home" to "Homepage" for improved clarity. - Revamped `docs/index.md` with detailed introduction, key features, quick start guide, and examples.
- Updated `ame` to `Name` to resolve YAML casing inconsistency in `.github/workflows/docs.yaml`.
- Added manual scope creation per invocation for proper scoped lifetime management. - Introduced manual service resolution within each scope for improved service lifecycle. - Updated comments and removed incorrect usage of singleton-scoped service for all invocations. - Improved clarity in the `LambdaBootstrapBuilder` example to reflect best practices.
- Configured palette toggles for light and dark modes in Material theme. - Included icons and descriptive labels for better user experience.
…ample - Replaced `BuildServiceProvider` usage to async with `await using` for proper disposal. - Adjusted comments to improve clarity on manual DI container setup process.
- Replaced manual DI setup, service resolution, and cancellation token management with streamlined `aws-lambda-host` patterns. - Highlighted automatic deserialization, DI injection, and JSON serialization in updated example. - Improved comments for clarity between `Traditional Lambda` and `aws-lambda-host` approaches.
- Changed `Name` to `name` to align with YAML casing conventions in `.github/workflows/docs.yaml`.
- Updated framework description to include lifecycle hooks alongside middleware and DI. - Adjusted code snippets to clarify builder pattern and proper async disposal.
- Standardized naming to `AwsLambda.Host` across docs for consistency. - Updated framework description to reference `.NET` patterns instead of `ASP.NET Core` patterns. - Replaced envelope package list with a detailed markdown table, including badges for NuGet versions and download counts.
|
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #203 +/- ##
=======================================
Coverage 90.68% 90.68%
=======================================
Files 102 102
Lines 2233 2233
Branches 254 254
=======================================
Hits 2025 2025
Misses 115 115
Partials 93 93 Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
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.

Summary
Implements a comprehensive landing page for the aws-lambda-host documentation site using MkDocs with Material theme. This PR adds the foundational documentation infrastructure and a compelling landing page that showcases the framework's value proposition.
Key Changes
Documentation Infrastructure
Landing Page Content (
docs/index.md)Technical Details
Material for MkDocs Features Used:
Code Example Highlights:
Documentation Plan
This landing page is Phase 1 of the comprehensive documentation plan stored in
.claude/DOCUMENTATION_PLAN.md. Future phases will add:Test Plan
References
.claude/DOCUMENTATION_PLAN.md.claude/plans/curious-riding-pudding.mdmkdocs.yml