Mkdocs

[taylorbobaylor]

Pull Request

Summary

This pull request revamps the project's documentation by migrating to the Material for MkDocs theme, providing a modern, responsive, and more user-friendly documentation site.

Key improvements include:

• A complete visual and functional overhaul of the documentation site.
• Streamlined mkdocs.yml configuration by removing broken links and unused plugins.
• Fixed the site logo path to ensure it renders correctly.
• Updated the documentation deployment workflow (docs.yml) to resolve build failures caused by deprecated actions and to allow for manual workflow execution.

---

✅ Checklist

• My changes build cleanly
• I’ve added/updated relevant tests
• I’ve added/updated documentation or README
• I’ve followed the coding style for this project
• I’ve tested the changes locally (if applicable)

---

Related Issues or PRs

Closes #...

---

Notes for Reviewers

• Please review the rendered documentation site to ensure all content is displayed correctly with the new theme.

[taylorbobaylor]

@ncipollina - Docs can be viewed on my fork for now: https://taylorbobaylor.github.io/cdk-constructs/

[ncipollina]

Overall, nice work!!! Copilot made some suggestions and I have a few observations:

On the docs home page:

• Title is duplicated:

* The emojis that were in the document have been repleced with text:

[taylorbobaylor]

Looks like it was still deploying the old documentation but I have made requested changes and looks to be deploying the actual material for mkdocs now: https://taylorbobaylor.github.io/cdk-constructs/

[Copilot]

Pull Request Overview

This PR migrates the project’s documentation from Jekyll to Material for MkDocs, streamlines configuration, fixes asset paths, enhances page layouts with emojis, and adds a new GitHub Actions workflow to deploy the MkDocs site.

• Updated the .csproj to point to the new icon location under docs/assets.
• Added mkdocs.yml with Material theme settings and removed Jekyll’s _config.yml.
• Revised documentation pages to use .md links and emoji-enhanced headings.
• Introduced a GitHub Actions workflow for building and deploying the MkDocs site.

Reviewed Changes

Copilot reviewed 9 out of 12 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/LayeredCraft.Cdk.Constructs/LayeredCraft.Cdk.Constructs.csproj	Adjusted icon asset path to docs/assets/icon.png
mkdocs.yml	New MkDocs configuration using Material theme and plugins
docs/index.md	Updated navigation links to include .md extensions
docs/constructs/static-site.md	Enhanced features list with emojis and corrected internal links
docs/constructs/lambda-function.md	Enhanced features list with emojis and corrected internal links
docs/constructs/dynamodb-table.md	Enhanced features list with emojis and corrected internal links
docs/assets/css/style.scss	Switched SCSS import for the new theme
docs/_config.yml	Removed old Jekyll configuration
.github/workflows/mkdocs-material-gh-pages.yml	New workflow to build and deploy the MkDocs site

Comments suppressed due to low confidence (2)

.github/workflows/mkdocs-material-gh-pages.yml:2

• The workflow currently only runs on pushes to main. To support manual execution as described in the PR notes, add a workflow_dispatch: trigger under on:.

on:

mkdocs.yml:12

• [nitpick] The copyright year is set to 2024. Consider updating this to the current year (2025) to keep the documentation up to date.

copyright: Copyright © 2024 LayeredCraft Team

[Copilot]

Using a Liquid template tag ({{ site.theme }}) inside an SCSS file will not be processed by the MkDocs SASS compiler. You should import the actual theme SCSS file path (e.g., @import "material";) or adjust your build to preprocess Liquid before SASS.

Suggested change

	@import "{{ site.theme }}";
	@import "material";

[ncipollina]

🚀 Nice work!!!

[ncipollina]

@all-contributors please add @taylorbobaylor for doc

[allcontributors]

@ncipollina

I've put up a pull request to add @taylorbobaylor! 🎉