Docs: new README (Arabic flows, screenshots) + AGENT.md for AI agents #2

Merged
ahmed merged 1 commits from docs/readme-agent-2026-10-09 into main 2026-10-09 17:23:32 +03:00
Owner

Documentation refresh.

README.md — rewritten

  • Matches the real stack (Next.js 15 + Payload 3 + PostgreSQL + Traefik) — the old README described the abandoned static prototype (python3 -m http.server, check_site.py).
  • Logo (web/public/brand/icon-256.png) + 4 live screenshots captured from production (docs/screenshots/): home, articles, post page, subscription.
  • Arabic flow explanations with mermaid diagrams: visitor journey, content-publishing pipeline, and the request path (browser → Traefik → Next → Payload → Postgres).
  • Features list, architecture table, quick start, API reference, security summary (rate limits, trust model, HSTS), deploy commands.

AGENT.md — new

Orientation for future AI agents: stack, repo layout, data model, the trusted-write/entitlement rules, auth + rate-limit internals, key routes, env vars, dev/verification commands, deployment, and house rules (ADR/GLOSSARY conventions, pentest context F1–F9 closed).

Also committed (linked from README)

  • GLOSSARY.md — canonical domain vocabulary
  • docs/adr/0001–0005 — architecture decision records

Not committed: NOTES.md (contains infra credentials/locations), security reports, .agents/, .claude/, workflows/.

Documentation refresh. ## README.md — rewritten - Matches the **real stack** (Next.js 15 + Payload 3 + PostgreSQL + Traefik) — the old README described the abandoned static prototype (`python3 -m http.server`, `check_site.py`). - Logo (`web/public/brand/icon-256.png`) + **4 live screenshots** captured from production (`docs/screenshots/`): home, articles, post page, subscription. - **Arabic flow explanations** with mermaid diagrams: visitor journey, content-publishing pipeline, and the request path (browser → Traefik → Next → Payload → Postgres). - Features list, architecture table, quick start, API reference, security summary (rate limits, trust model, HSTS), deploy commands. ## AGENT.md — new Orientation for future AI agents: stack, repo layout, data model, the trusted-write/entitlement rules, auth + rate-limit internals, key routes, env vars, dev/verification commands, deployment, and house rules (ADR/GLOSSARY conventions, pentest context F1–F9 closed). ## Also committed (linked from README) - `GLOSSARY.md` — canonical domain vocabulary - `docs/adr/0001–0005` — architecture decision records Not committed: `NOTES.md` (contains infra credentials/locations), security reports, `.agents/`, `.claude/`, `workflows/`.
ahmed added 1 commit 2026-10-09 17:23:32 +03:00
- README rewritten for the real Next.js + Payload + Postgres stack
  (old one described the dead static prototype)
- Logo + 4 live screenshots (home, articles, post, subscription)
- Arabic flow explanations with mermaid diagrams: visitor journey,
  content pipeline, request path
- Architecture table, quick start, API reference, security summary,
  deploy commands
- AGENT.md: orientation for future AI agents (data model, trust rules,
  rate limits, routes, env, deploy, house rules)
- GLOSSARY.md and docs/adr committed (linked from README)
ahmed merged commit 82414e8a93 into main 2026-10-09 17:23:32 +03:00
Sign in to join this conversation.
No Reviewers
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: ahmed/anwar-pi-website#2