Docs/website and readme - #58
Merged
Merged
Conversation
cmd/sqlguard opened "postgres"/"mysql" by name but imported no driver, so every `sqlguard explain` failed with `sql: unknown driver`. Blank-import pgx/v5/stdlib and go-sql-driver/mysql from db.go only; library consumers of analyzer/middleware never link them since Go compiles per package.
lint-docs runs markdownlint-cli2 (from website/node_modules) over every Markdown file in the repo; config and rationale in .markdownlint-cli2.jsonc. Wired into `make ci` and `make fix`.
Lives in website/ on main (TypeScript, Biome, versioned docs). Twenty guide pages covering the middleware, rules, config, CLI, integrations and extension seams, plus a landing page with measured benchmark figures. Docs are versioned by snapshot per website/VERSIONING.md; 0.2 is the first snapshot so /docs/ serves the released version and /docs/next/ tracks main. Includes the logo, favicon, social card and README terminal mockup.
Centered logo and badges, a "Why sqlguard?" comparison, condensed features, quick start, and a guide index pointing at the docs site. The per-feature deep dives moved to website/docs.
Add the Docs workflow (check on PRs, deploy to Pages from main), a markdown lint job in CI, YAML issue forms with structured fields, a docs checklist line in the PR template, and Dependabot tracking for website/. Codecov ignores website/; drop the stale sqlguard-website gitignore entry.
AGENTS.md gains a Documentation website section (versioning by snapshot, version markers, never edit versioned_docs) and an updated dependency note for the CLI drivers. Greptile and CodeRabbit ignore frozen snapshots and generated assets and check website/docs for exact names and version markers. CONTRIBUTING and CHANGELOG updated to match.
Node >= 20.12 refuses to spawn npx.cmd without a shell on Windows, so the cut failed with ENOENT/EINVAL there. Invoke the CLI entry point with process.execPath, which is what `npm run docusaurus` resolves to anyway.
Contributor
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
What does this PR change, and why?
Closes #
Type of change
Checklist
make cipasses (fmt-check, vet, lint, test-race) across all modulesREADME.md,AGENTS.md,.sqlguard.example.yml)## [Unreleased]inCHANGELOG.mdanalyzer/middleware/reporterResult)Notes for reviewers
Anything reviewers should focus on — tricky areas, trade-offs, follow-ups.