feat: Nav switchup and some minor updates (#18)

## Summary

Rethink my nav setup for cloud providers and some minor updates.

## ✨ Features
- Add info about pre-commit and add my hook info
[`1b8d7b0`](1b8d7b0)
- Migrate tf/tofu to have cloud providers instead of general sections
[`ebbf6b3`](ebbf6b3)
- Migrate tf/tofu to have cloud providers instead of general sections
[`f219eeb`](f219eeb)
- Add a description field to pages for a future use
[`9f27635`](9f27635)
- Add hook for linting actions
[`d5859aa`](d5859aa)

## 🐛 Bug Fixes
- remove example section now that I know how the blocks work for the
most part
[`4926d32`](4926d32)
- Move terragrunt section to under tf/tofu
[`95c40d4`](95c40d4)
- Attempt to fix lychee runs
[`2c02b01`](2c02b01)

## 📚 Documentation
- Update readme
[`26da05e`](26da05e)

## 💄 Style
- update docs
[`ba85cfc`](ba85cfc)

## 🏗️ Operations
- Add `CAF` to codespell ignore
[`917a648`](917a648)
- fix some codespell calls
[`c11256f`](c11256f)
- Update uv lock
[`0f48d5a`](0f48d5a)
- Update config
[`0f42506`](0f42506)
- Expand renovate config
[`b1fc3a9`](b1fc3a9)
- set pyton minimum to 3.12
[`32d5967`](32d5967)
- Add base contribution file
[`64b295c`](64b295c)

## 📁 File Changes

### Root (+60/-77 lines)
- `.pre-commit-config.yaml` (+5) 📝
- `pyproject.toml` (+2/-2) 📝
- `renovate.json` (+23/-1) 📝
- `uv.lock` (+1/-60) 📝
- `zensical.toml` (+29/-14) 📝

### .github (+11/-12 lines)
- `.github/workflows/ci.yml` (+9/-9) 📝
- `.github/workflows/deploy.yml` (+2/-3) 📝

### Terragrunt (+5/-5 lines)
- `terragrunt/terragrunt.hcl` (+5/-5) 📝

### Documentation (+4740/-536 lines)
- `CONTRIBUTING.md` (+40) ✨
- `README.md` (+10/-1) 📝
- `docs/api/error-responses.md` (+1) 📝
- `docs/api/fastapi-skeleton.md` (+1) 📝
- `docs/api/go-chi-skeleton.md` (+1) 📝
- `docs/api/index.md` (+1) 📝
- `docs/api/openapi.md` (+1) 📝
- `docs/api/pagination.md` (+1) 📝
- `docs/containers/compose-dev.md` (+1) 📝
- `docs/containers/distroless.md` (+1) 📝
- `docs/containers/dockerfile-go.md` (+1) 📝
- `docs/containers/dockerfile-node.md` (+1) 📝
- `docs/containers/dockerfile-python.md` (+1) 📝
- `docs/containers/index.md` (+1) 📝
- `docs/data/airflow-dag.md` (+1) 📝
- `docs/data/alembic-skeleton.md` (+1) 📝
- `docs/data/dbt-skeleton.md` (+1) 📝
- `docs/data/index.md` (+1) 📝
- `docs/data/postgres-conventions.md` (+1) 📝
- `docs/data/postgres-indexes.md` (+1) 📝
- `docs/examples/code-blocks.md` (-358) 🗑️
- `docs/github-actions/container-build.md` (+1) 📝
- `docs/github-actions/index.md` (+1) 📝
- `docs/github-actions/oidc-aws.md` (+1) 📝
- `docs/github-actions/oidc-gcp-azure.md` (+1) 📝
- `docs/github-actions/path-filtered-matrix.md` (+1) 📝
- `docs/github-actions/release.md` (+1) 📝
- `docs/github-actions/reusable-workflows.md` (+1) 📝
- `docs/hygiene/editorconfig.md` (+1) 📝
- `docs/hygiene/gitignore.md` (+1) 📝
- `docs/hygiene/index.md` (+1) 📝
- `docs/hygiene/makefile.md` (+1) 📝
- `docs/hygiene/pre-commit.md` (+175/-8) 📝
- `docs/index.md` (+2/-9) 📝
- `docs/kubernetes/deployment-baseline.md` (+1) 📝
- `docs/kubernetes/helm-skeleton.md` (+1) 📝
- `docs/kubernetes/index.md` (+1) 📝
- `docs/kubernetes/probes.md` (+1) 📝
- `docs/kubernetes/rbac.md` (+1) 📝
- `docs/kubernetes/scaling.md` (+1) 📝
- `docs/observability/index.md` (+1) 📝
- `docs/observability/opentelemetry.md` (+1) 📝
- `docs/observability/prometheus.md` (+1) 📝
- `docs/observability/structured-logging.md` (+1) 📝
- `docs/terraform/aws/backends.md` (+248) ✨
- `docs/terraform/aws/iam-policies.md` (+365) ✨
- `docs/terraform/aws/index.md` (+44) ✨
- `docs/terraform/aws/module-skeleton.md` (+312) ✨
- `docs/terraform/aws/providers.md` (+296) ✨
- `docs/terraform/aws/variables.md` (+11/-17) ↻
- `docs/terraform/azure/backends.md` (+190) ✨
- `docs/terraform/azure/iam-policies.md` (+233) ✨
- `docs/terraform/azure/index.md` (+44) ✨
- `docs/terraform/azure/module-skeleton.md` (+349) ✨
- `docs/terraform/azure/providers.md` (+247) ✨
- `docs/terraform/azure/variables.md` (+325) ✨
- `docs/terraform/backends.md` (-19) 🗑️
- `docs/terraform/gcp/backends.md` (+226) ✨
- `docs/terraform/gcp/iam-policies.md` (+233) ✨
- `docs/terraform/gcp/index.md` (+44) ✨
- `docs/terraform/gcp/module-skeleton.md` (+254) ✨
- `docs/terraform/gcp/providers.md` (+222) ✨
- `docs/terraform/gcp/variables.md` (+318) ✨
- `docs/terraform/iam-policies.md` (-19) 🗑️
- `docs/terraform/index.md` (+9/-15) 📝
- `docs/terraform/module-skeleton.md` (-19) 🗑️
- `docs/terraform/providers.md` (-18) 🗑️
- `docs/terraform/terragrunt/index.md` (+88) ✨
- `docs/terraform/terragrunt/root-config.md` (+216) ✨
- `docs/terraform/terragrunt/stacks.md` (+200) ✨
- `docs/terragrunt/index.md` (-17) 🗑️
- `docs/terragrunt/root-config.md` (-18) 🗑️
- `docs/terragrunt/stacks.md` (-18) 🗑️

---

**Changes:** 81 files, +4816 insertions, -630 deletions
**Commits:** 17
**Branch:** `feat/ci-and-nav`
**Base:** `origin/main`

Author: RemoteRabbit

.github/workflows/ci.yml

@@ -16,11 +16,6 @@ jobs:
         with:
           fetch-depth: 0
 
-      # - name: Install lychee
-      #   run: |
-      #     curl -sSf '<https://sh.rustup.rs>' | sh
-      #     apt install gcc pkg-config libc6-dev libssl-dev
-
       - uses: astral-sh/setup-uv@v8.1.0
         with:
           enable-cache: true
@@ -32,8 +27,13 @@ jobs:
       - name: Install dependencies
         run: uv sync --frozen
 
-      # - name: Run pre-commit
-      #   run: uv run pre-commit run --all-files --show-diff-on-failure
+      - name: Install lychee
+        uses: taiki-e/install-action@v2
+        with:
+          tool: lychee
+
+      - name: Run pre-commit
+        run: uv run pre-commit run --all-files --show-diff-on-failure
 
-      - name: Build site
-        run: uv run zensical build
+      - name: Build site (strict)
+        run: uv run zensical build --strict

.github/workflows/deploy.yml

@@ -39,9 +39,8 @@ jobs:
       - name: Install dependencies
         run: uv sync --frozen --no-dev
 
-      - name: Build site
-        # See ci.yml for why --strict is disabled.
-        run: uv run zensical build
+      - name: Build site (strict)
+        run: uv run zensical build --strict
 
       - uses: actions/configure-pages@v6
 

.pre-commit-config.yaml

@@ -31,6 +31,11 @@ repos:
         stages: [commit-msg]
         args: [ops]
 
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.12
+    hooks:
+      - id: actionlint
+
   - repo: local
     hooks:
       - id: zensical-build

CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing
+
+This is primarily a personal stash of boilerplate I keep rewriting, published
+in the small chance someone else finds it useful.
+
+PRs are welcome but not actively solicited. If you spot a bug or want to add a
+snippet, feel free to open an issue or PR just keep in mind I'll prioritize
+based on whether I'd use it myself.
+
+## Local setup
+
+See [README.md](README.md) it covers `uv`, `make install`, and the local
+dev loop.
+
+## Conventions
+
+- **Conventional Commits** for commit messages (enforced via `pre-commit` on
+  the `commit-msg` hook). Allowed types are configured in
+  [`.pre-commit-config.yaml`](.pre-commit-config.yaml).
+- **Run `make pre-commit`** before pushing. CI runs the same hooks plus a
+  strict Zensical build.
+- **Snippets should be self-contained** copy a single block and it works.
+  Cite the upstream docs at the bottom of every page.
+- **Validate variables**. New Terraform variable blocks should follow the
+  pattern in [`docs/terraform/aws/variables.md`](docs/terraform/aws/variables.md):
+  type, description, sensible default (or `nullable = true`), and a
+  `validation` block with a complete-sentence `error_message`.
+
+## Reporting issues
+
+Open a GitHub issue with:
+
+- The page URL or path
+- What's wrong (typo, broken link, outdated example, missing context)
+- Optionally a suggested fix
+
+## License
+
+By contributing you agree your changes will be released under the project's
+[GPL-3.0 license](LICENSE).

README.md

@@ -23,7 +23,7 @@ useful:
 | `lychee.toml`                | [lychee](https://lychee.cli.rs/) link-checker config (used by pre-commit and CI).                              |
 | `.editorconfig`              | Whitespace defaults across editors.                                                                            |
 | `Makefile`                   | Convenience targets — run `make help`.                                                                         |
-| `terragrunt/`                | Working Terragrunt example referenced by the docs *(WIP — being modernized)*.                                  |
+| `terragrunt/`                | Legacy Terragrunt example. Modern patterns live in [`docs/terraform/terragrunt/`](docs/terraform/terragrunt/). |
 | `.github/workflows/`         | `ci.yml` (PR checks), `deploy.yml` (Pages deploy on push to `main`), `links.yml` (lychee on PR + weekly cron). |
 
 ## Local development
@@ -79,3 +79,12 @@ This site originally ran on [Material for MkDocs](https://squidfunk.github.io/mk
 it now runs on [Zensical](https://zensical.org/), the team's new SSG. Zensical
 is currently alpha, so the dependency is pinned to an exact version
 (see [`pyproject.toml`](pyproject.toml)) and bumped deliberately.
+
+## Contributing
+
+This is primarily a personal stash, but PRs and issues are welcome. See
+[CONTRIBUTING.md](CONTRIBUTING.md) for the local setup and conventions.
+
+## License
+
+Released under the [GPL-3.0 license](LICENSE).

docs/api/error-responses.md

@@ -1,5 +1,6 @@
 ---
 title: RFC 7807 problem+json
+description: RFC 7807 problem-detail error responses for HTTP APIs.
 status: stub
 tags:
   - api

docs/api/fastapi-skeleton.md

@@ -1,5 +1,6 @@
 ---
 title: FastAPI service skeleton
+description: Opinionated FastAPI project layout with settings, routers, and dependencies.
 status: stub
 tags:
   - api

docs/api/go-chi-skeleton.md

@@ -1,5 +1,6 @@
 ---
 title: Go chi service skeleton
+description: Minimal Go service skeleton built on chi with structured logging and graceful shutdown.
 status: stub
 tags:
   - api

docs/api/index.md

@@ -1,5 +1,6 @@
 ---
 title: API / Backend
+description: Service skeletons, error responses, pagination, and OpenAPI starters.
 status: stub
 tags:
   - api

docs/api/openapi.md

@@ -1,5 +1,6 @@
 ---
 title: OpenAPI starter + lint
+description: OpenAPI 3 starter spec plus linting with spectral or vacuum.
 status: stub
 tags:
   - api