supabase / splinter

Supabase Postgres Linter: Performance and Security Advisors
https://supabase.github.io/splinter/
83 stars 7 forks source link

Suggestion: add a 'docs link' in response / or use markdown for links in details #33

Closed MildTomato closed 5 months ago

MildTomato commented 6 months ago

Chore

Describe the chore

An example of a URL for a docs link can be seen here

Might be more useful for formatting responses if this was in markdown, or perhaps maybe we add another column in view for a docs link. Make it easier to build a user interface around linting responses.

Additional context

Add any other context or screenshots that help clarify the task.

olirice commented 6 months ago

We have the remediation column that contains a reference to the docs here https://github.com/supabase/splinter/blob/264ee0a080e7664571254d45a59e9b92f1efe2c4/lints/0003_auth_rls_initplan.sql#L68

is that what you're looking for, or did I misunderstand?

olirice commented 5 months ago

remediation now points to the official supabase docs, which mirrors docs/

we also use markdown for text blocks

pls re-open if I misunderstood the issue