feat: lint summaries

[dnywh]

What is the current behavior?

Our lints have a quite technical explanation of cause and effect but are missing some basic “what does this mean for me” for less technical folks

What is the new behavior?

A new plain-English summary field and ramification field for each lint. These summarise the issue and give a sense of why it’s important to act on, respectively.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: 26a47115-aa38-409d-ac98-538f97546036

📥 Commits

Reviewing files that changed from the base of the PR and between b9de3a3 and f111731.

📒 Files selected for processing (25)

• docs/0001_unindexed_foreign_keys.md
• docs/0002_auth_users_exposed.md
• docs/0003_auth_rls_initplan.md
• docs/0004_no_primary_key.md
• docs/0005_unused_index.md
• docs/0006_multiple_permissive_policies.md
• docs/0007_policy_exists_rls_disabled.md
• docs/0008_rls_enabled_no_policy.md
• docs/0009_duplicate_index.md
• docs/0010_security_definer_view.md
• docs/0011_function_search_path_mutable.md
• docs/0012_auth_allow_anonymous_sign_ins.md
• docs/0013_rls_disabled_in_public.md
• docs/0014_extension_in_public.md
• docs/0015_rls_references_user_metadata.md
• docs/0016_materialized_view_in_api.md
• docs/0017_foreign_table_in_api.md
• docs/0018_unsupported_reg_types.md
• docs/0019_insecure_queue_exposed_in_api.md
• docs/0020_table_bloat.md
• docs/0021_fkey_to_auth_unique.md
• docs/0022_extension_versions_outdated.md
• docs/0023_sensitive_columns_exposed.md
• docs/0024_permissive_rls_policy.md
• mkdocs.yaml

Cache: Disabled due to Reviews > Disable Cache setting

Disabled knowledge base sources:

• Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.

---

📝 Walkthrough

Summary by CodeRabbit

• Documentation
  • Improved formatting and structure for database diagnostic documentation with clearer visual presentation.
  • Added detailed summaries and explanations for 24 database checks and security warnings.
  • Updated navigation menu with 10 new diagnostic check references.

Walkthrough

This pull request standardizes documentation formatting across 24 lint definition files. Each file is reformatted to consistently present metadata fields using bold Markdown syntax—converting "Level: X" to "Level: X" and adding structured "Summary:" and "Ramification:" sections followed by a horizontal rule separator. Additionally, the mkdocs navigation configuration is updated to include 10 new lint entries in the navigation menu. All changes are purely documentation formatting and configuration updates with no functional code modifications.

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[dnywh]

These lints were missing from the nav. This adds them in.