Update checkly rules and TS Docs reference docs#1179
Conversation
stefanjudis
force-pushed
the
update-checkly-rules
branch
from
7b6887d to
4dde546
Compare
stefanjudis
force-pushed
the
update-checkly-rules
branch
from
4dde546 to
ad07889
Compare
| * }) | ||
| * ``` | ||
| * | ||
| * @see {@link https://www.checklyhq.com/docs/cli/constructs-reference/#alertchannel | AlertChannel API Reference} |
There was a problem hiding this comment.
There's no general alertChannel construct docs page anymore.
| * @see {@link https://www.checklyhq.com/docs/cli/constructs-reference/#apicheck | ApiCheck API Reference} | ||
| * @see {@link https://www.checklyhq.com/docs/monitoring/api-checks/ | API Checks Documentation} | ||
| */ | ||
| /** |
There was a problem hiding this comment.
This entire section was a duplicate of the above.
| * @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/api-checks/overview/ | ||
| * API Checks Documentation} |
There was a problem hiding this comment.
I think you have to keep @links as one line. Just tried in VS Code and it doesn't render correctly the way you have it here.
| * @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/api-checks/overview/ | |
| * API Checks Documentation} | |
| * @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/api-checks/overview/ API Checks Documentation} |
And then it looks like we'd have to add ignoreComments: true to aslant.config.mjs:
'max-len': ['error',
{
code: 120,
ignoreTemplateLiterals: true,
ignoreStrings: true,
ignoreComments: true,
},
],
There was a problem hiding this comment.
@sorccu Here's the thing, I looked into exactly this. I had them on one line, but ESLint was complaining. Then I changed ignoreComments, but wasn't sure if that's "a bit too much of a change"? And then I saw this "multi-line @link pattern" in other places to I adjusted. :D
I'll change the ESLint config and fix these multi lines.
There was a problem hiding this comment.
If we have multi-line @links then they're all likely broken
| * @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/browser-checks/overview/ | ||
| * Browser Checks Documentation} |
packages/cli/src/constructs/check.ts
Outdated
| * @see {@link https://www.checklyhq.com/docs/communicate/status-pages/incidents/#incident-automation | ||
| * Incident Automation} |
| * @see {@link https://www.checklyhq.com/docs/communicate/dashboards/configuration/#custom-domain | ||
| * Custom Domain Setup} |
| * {@link https://www.checklyhq.com/docs/integrations/incident-management/opsgenie/ | ||
| * docs on where to create this API key} |
| * {@link https://www.checklyhq.com/docs/integrations/alerts/phone-calls/#supported-countries-and-regions | ||
| * List of supported countries} |
| * @see {@link https://www.checklyhq.com/docs/detect/synthetic-monitoring/playwright-checks/overview/ | ||
| * Playwright Checks Documentation} |
sorccu
left a comment
sorccu
left a comment
There was a problem hiding this comment.
I trust that the links are correct.
|
@sorccu Yep I manually checked in the browser before. I don't think we need to double check at this point because regardless these TSDocs are more correct than what we had. :D |
2 participants
Affected Components
Notes for the Reviewer
Context: https://checklyhq.slack.com/archives/C04PFSV5W3B/p1763590140631109
This PR fixes broken doc URLs in
checkly.rules.mdand, while I was at it, fixes all the TSDocs references. Note that some doc pages no longer exist. I removed the docs' references in this case and made a note to bring back the affected pages.