Skip to content

docs: add docs/ README index #911

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
alehar9320-bot wants to merge 3 commits into from
Closed

docs: add docs/ README index #911

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fe473bc
docs: add docs/ README index
alehar9320-bot Sep 2, 2026
8c4ea17
Merge branch 'main' into docs/add-docs-index
alehar9320-bot Sep 2, 2026
ba1d38c
ci: retrigger Quality for docs/README index
alehar9320-bot Sep 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# docs/

Engineering documentation for this repo. Visitor copy lives on the live site ([https://me.alehar.workers.dev/](https://me.alehar.workers.dev/)). The [GitHub Wiki](https://github.com/alehar9320/astro-cloudflare-personal-website/wiki) is a map only; it is not a second source of truth.

## Index

| Path | Role |
| --- | --- |
| [adr/0001-cloudflare-production-render-jules.md](adr/0001-cloudflare-production-render-jules.md) | ADR: Cloudflare Workers = production; Render = Jules test env (not failover) |
| [mcp.md](mcp.md) | MCP server setup for AI agents (Cursor and siblings) |
| [zod-guidelines.md](zod-guidelines.md) | Zod schema-first / runtime validation practices |
| [inspirations.md](inspirations.md) | Reference personal sites for design and structure |

## Nearby (repo root)

| Path | Role |
| --- | --- |
| [README.md](../README.md) | Human front door: what this is, how to run, how prod deploys |
| [AGENTS.md](../AGENTS.md) | AI / agent source of truth |
| [SECURITY.md](../SECURITY.md) | Vulnerability reports via LinkedIn |
| GitHub Releases | Canonical changelog (prefer releases over root `CHANGELOG.md`) |

## Locks (do not undo in docs)

- Hire path: [LinkedIn](https://www.linkedin.com/in/alehar/) only (no public email, no mailto hire, no placeholder CV PDF).
- Production host: Cloudflare Workers only.
- GitHub Pages stays off.