Skip to content

docs: clarify built-in and custom rules - #38

Merged
kvlonge merged 1 commit into
mainfrom
docs/rules-builtins-custom
Sep 10, 2026
Merged

kvlonge merged 1 commit into
mainfrom
docs/rules-builtins-custom

Conversation

@kvlonge

@kvlonge kvlonge commented Sep 10, 2026

Copy link
Copy Markdown
Contributor

Why

The Rules overview repeated its opening review examples as a second abstract question list. It also did not clearly explain how built-ins and custom Rules serve different adoption needs, and the SQL responsibility table could imply that SQBRSQL runs outside compilation.

Changes

  • replace the repetitive question list with a concise built-in/custom distinction
  • describe built-ins as individually selectable opinionated defaults and examples
  • explain that custom Rules capture project- or company-specific decisions too narrow for universal defaults
  • clarify that SQBRSQL Rules are executed by the compiler
  • clarify that sqb format remains separate from the compiler

Verification

  • public-repository hygiene scan
  • git diff --check
  • manual review of the rendered MDX structure and links

@kvlonge
kvlonge enabled auto-merge (squash) September 10, 2026 07:01
@kvlonge
kvlonge merged commit af46a1b into main Sep 10, 2026
3 checks passed
@kvlonge
kvlonge deleted the docs/rules-builtins-custom branch September 10, 2026 07:01
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.

1 participant