Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.17 KB

README.md

File metadata and controls

36 lines (27 loc) · 1.17 KB

pgrls-docs

Public docs site for pgrls — the static analyzer for Postgres Row-Level Security.

Live at https://pgrls.github.io/pgrls-docs/.

Layout

  • index.md — landing page.
  • comparisons/ — pgrls vs adjacent tools (sqlfluff, Atlas, Semgrep, CodeQL, Snyk, squawk) and ecosystem positioning (Supabase, PostgREST, Hasura).
  • _config.yml — Jekyll + Just the Docs remote theme.

Editing

Pages are plain Markdown with Jekyll front matter (title / parent / nav_order). Pushes to main rebuild via GitHub Pages automatically — no local Jekyll required for content edits.

For local preview:

bundle install
bundle exec jekyll serve --baseurl ""

Where things live

Concern Repo
Linter source + product docs (README, Quickstart, recipes, AGENTS) pgrls/pgrls
Public docs site (you are here) pgrls/pgrls-docs
GitHub Action (Marketplace) pgrls/pgrls-action
Marketing collateral (launch posts, etc.) pgrls-marketing (private)