Skip to content

docs: add website, scenarios, and agent skill; remove stale docs#194

Merged
AbeOmor merged 21 commits into
mainfrom
cleanup/website-skill-scenarios
May 29, 2026
Merged

docs: add website, scenarios, and agent skill; remove stale docs#194
AbeOmor merged 21 commits into
mainfrom
cleanup/website-skill-scenarios

Conversation

@AbeOmor
Copy link
Copy Markdown
Contributor

@AbeOmor AbeOmor commented May 29, 2026

Summary

Cleans up pg_durable docs and adds a static website, a scenarios guide, and the reusable agent skill.

Added

  • .agents/skills/pg-durable-sql/ — moved the pg-durable-sql agent skill from .github/skills/ so agents (e.g. GitHub Copilot) can generate durable-function SQL.
  • docs/website/ — static landing page (renamed from getting-started), deployed via GitHub Pages. Includes:
    • A "What you can build" section with use-case cards and a prominent callout to the full Scenarios guide.
    • An AI Skill section pointing to the pg-durable-sql skill.
    • An Open-source durable functions section.
    • A managed Azure HorizonDB section.
    • Repo links normalized to microsoft/pg_durable.
  • docs/SCENARIOS.md — consolidated scenarios guide:
    • Part 1: Database & ETL Patterns (Scenarios 1–5).
    • Part 2: Standard Operational Scenarios → links to examples/operational-scenarios/ (autovacuum blocked, database bloat, wraparound risk, tables not vacuumed).
    • Part 3: Azure Integration Examples → links to examples/azure-functions/, examples/azure-http-domains/, examples/invoice-approval/.
  • examples/operational-scenarios/ — anonymized vacuum/bloat/wraparound DB-ops scenarios (SQL + README + design doc), referenced as Part 2 in docs/SCENARIOS.md.
  • .github/workflows/pages.yml — auto-deploys docs/website/ to GitHub Pages on pushes to main.

Removed

  • docs/bug-bash-april-2026.md
  • docs/pgai-vectorizer-durable-functions.md

Notes

  • "Test pg_textsearch and update docs" was skipped for now per discussion.

AbeOmor added 12 commits May 29, 2026 15:14
- Move pg-durable-sql skill from .github/skills to .agents/skills
- Add docs/website (renamed from getting-started); link the skill and add 'OSS Durable Functions — coming soon'
- Add docs/SCENARIOS.md, docs/ai/, and Sarat_scenarios; reference Sarat scenarios from SCENARIOS.md
- Remove docs/bug-bash-april-2026.md and docs/pgai-vectorizer-durable-functions.md
…ge/Hanken/JetBrains type, blueprint atmosphere, motion)
@AbeOmor AbeOmor marked this pull request as ready for review May 29, 2026 20:05
@AbeOmor
Copy link
Copy Markdown
Contributor Author

AbeOmor commented May 29, 2026

@pinodeca! When this merges, can you do the following to get the website live!

One-time setup (repo admin, in GitHub UI)
Go to the repo → Settings → Pages.
Under Build and deployment → Source, select GitHub Actions (not "Deploy from a branch").
That's the only manual step, and it only needs to be done once.

Copy link
Copy Markdown
Contributor

@pinodeca pinodeca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I asked Opus 4.7 to do a review mostly focused on changes you may have made to existing files. The only finding was a missing trailing newline - that pre-dates your changes.

I would go ahead and merge as-is so we get a 1st version of the website/Pages - then we can improve it as needed.

@AbeOmor AbeOmor merged commit d4fdff3 into main May 29, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants