Include per rule documentation website links to github comments

[ikavalio]

Hello!

https://squawkhq.com/docs is such an incredible source of information, I wonder if it makes sense to include direct links to violated rule documentation under https://squawkhq.com/docs to github comments? When users are new to squawk and postgres migrations, it takes a little bit of time to discover rule documentation website if you see a github comment for the first time.

To be fair squawk comment has plenty of data and a few external urls, but none of them have as much detail as https://squawkhq.com/docs or point directly to documentation website:

• There is a link to README https://github.com/sbdchd/squawk#rules and the paragraph points to https://squawkhq.com/docs but the actual URL is at the very bottom of the README block -

  squawk/README.md

  Line 234 in dbb9781

  See the [Squawk website](https://squawkhq.com/docs/rules) for documentation on each rule with examples and reasoning.

I don't know if it's a good idea, but a new Rule Documentation block after Rule Violations

squawk/crates/squawk/src/github.rs

Lines 342 to 361 in dbb9781

	<h3><code>{filename}</code></h3>
	```sql
	{sql}
	```{truncation_notice}
	<h4>{violations_emoji} Rule Violations ({violation_count})</h4>
	{violation_content}
	---
	",
	violations_emoji = violations_emoji,
	filename = violation.filename,
	sql = display_sql,
	truncation_notice = truncation_notice,
	violation_count = violation_count,
	violation_content = violation_content
	))
	}

that lists all unique violated rules and points to documentation website could work? (or just a single block at the end of the comment with unique links across all files)

[sbdchd]

Oh yeah that's a good idea! I think we were avoiding it on the cli output because it could be verbose, but we can hyperlink in the github comment!