Update docs

Author: rnag

.github/workflows/gh-pages.yml

@@ -0,0 +1,30 @@
+name: Deploy Docs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+
+      - name: Install dependencies
+        run: |
+          pip install .[docs]
+
+      - name: Build site
+        run: mkdocs build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v6
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site

.readthedocs.yaml

@@ -6,25 +6,24 @@
 [![GitHub Actions](https://github.com/rnag/py-secrets-cache/actions/workflows/release.yml/badge.svg)](https://github.com/rnag/py-secrets-cache/actions/workflows/release.yml)
 [![Documentation Status](https://readthedocs.org/projects/secrets-cache/badge/?version=latest)](https://secrets-cache.readthedocs.io/en/latest/?version=latest)
 
-> [!TIP]
-> Want a full AWS Lambda + CDK deployment example?
-> Check out [secrets-cache-cdk-example](https://github.com/rnag/secrets-cache-cdk-example)
-> for a ready-to-deploy Python CDK project that demonstrates `secrets-cache` usage
-> with Secrets Manager and SSM parameters, including caching timings.
+!!! tip
+    Check out [secrets-cache-cdk-example](https://github.com/rnag/secrets-cache-cdk-example)
+    for a ready-to-deploy AWS Lambda + CDK project demonstrating `secrets-cache` usage
+    with Secrets Manager and SSM parameters, including caching timings.
 
 Cache secrets locally from AWS Secrets Manager and other secret stores, with optional local caching for development or Lambda-friendly usage.
 
 * PyPI package: https://pypi.org/project/secrets-cache/
 * Free software: MIT License
-* Documentation: https://secrets-cache.readthedocs.io.
+* Documentation: https://secrets-cache.readthedocs.io
 
 ## Installation
 
 Install the base package (minimal, Lambda-friendly):
 
 ```bash
 pip install secrets-cache[lambda]
-````
+```
 
 For local development or testing (with local TOML caching, AWS SDK):
 
@@ -84,7 +83,7 @@ When running in AWS Lambda, you usually don’t want file-based caching. Use the
 
 ```bash
 pip install secrets-cache[lambda]
-````
+```
 
 ### Example Lambda handler
 

README.md

@@ -1,16 +1,6 @@
-# Welcome to Secrets Cache's documentation!
-
-## Contents
-
-- [Readme](readme.md)
-- [Installation](installation.md)
-- [Usage](usage.md)
-- [Modules](modules.md)
-- [Contributing](contributing.md)
-- [History](history.md)
-
-## Indices and tables
-
-- [Index](genindex)
-- [Module Index](modindex)
-- [Search](search)
+<!-- include README.md content -->
+{%
+    include-markdown "../README.md"
+    start="<!--intro-start-->"
+    end="<!--intro-end-->"
+%}

docs/index.md

@@ -0,0 +1,27 @@
+site_name: "Secrets Cache"
+site_url: "https://rnag.github.io/py-secrets-cache/"
+theme:
+  name: material
+  features:
+    - navigation.tabs
+    - navigation.instant
+markdown_extensions:
+  - admonition      # enables [!TIP], [!NOTE], etc.
+  - codehilite
+  - toc:
+      permalink: true
+
+nav:
+  - Home: index.md
+  - Installation: installation.md
+  - Usage: usage.md
+  # - Lambda Example: lambda_example.md
+  # - Features: features.md
+  # - Credits: credits.md
+
+docs_dir: docs
+
+plugins:
+  - search
+  - include-markdown
+

mkdocs.yml

@@ -42,6 +42,13 @@ local = [
     'tomli-w>=1.0',  # TOML writer for Python <3.11
     'tomli>=2.0; python_version<"3.11"',  # TOML reader for Python <3.11
 ]
+docs = [
+    'mkdocs',
+    'mkdocs-material',
+    'mkdocs-markdownextradata-plugin',
+    'mkdocs-macros-plugin',
+    'mkdocs-include-markdown-plugin',
+]
 lambda = []              # Lambda-friendly, skips boto3
 test = [
     "coverage",  # testing