Skip to content

Conversation

@sujaya-sys
Copy link
Contributor

@sujaya-sys sujaya-sys commented Dec 12, 2025

Affected Components

  • Content & Marketing
  • Pricing
  • Test
  • Docs
  • Learn
  • Other

Motivation

Currently, the dev docs on Assertions live within the API checks folder: https://www.checklyhq.com/docs/detect/synthetic-monitoring/api-checks/assertions/. They contain a lot of general information on assertions which are not only valid in the context on API checks - this has led us to link to the API check docs from other check types, which is confusing.

For that reason the proposal is to have top level assertion docs which we can link to from all check types.

Implementation Notes

  • "Assertions" are now a top level item in the "Detect" category. I was debating moving them into "Uptime Monitoring" instead, the main issue here is that we'd be linking to it from "API checks" (Which is in the "Synthetic Monitoring" folder)

  • I've put redirects in place for pages that have been removed / renamed, would need to verify that these work correctly

  • Once this is live, we need to update the links in the web-app.

Comment on lines 6 to 7
- /detect/synthetic-monitoring/api-checks/assertions/
- /detect/synthetic-monitoring/api-checks/requests/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do these make sure that the old links still work? For example, the CLI repo links to various places in the documentation and we should try to avoid breaking them.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I was hoping for more intel on that as well as this is my first time setting up redirects.

One thing I realized is that alias doesn't seem to be a thing in Mintlify, I just updated the PR based on what Mintlify's docs say: https://www.mintlify.com/docs/create/redirects.

If there are no objections I'd verify this change first thing once its live and make adjustments if necessary.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think what you've set up with redirects should work. (At least, it does on the preview deployment.) Most of our redirects are set via the marketing site repo, but not sure if it matters in this case.

Comment on lines 6 to 7
- /detect/synthetic-monitoring/api-checks/assertions/
- /detect/synthetic-monitoring/api-checks/requests/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think what you've set up with redirects should work. (At least, it does on the preview deployment.) Most of our redirects are set via the marketing site repo, but not sure if it matters in this case.

sujaya-sys and others added 2 commits December 17, 2025 08:56
@sujaya-sys sujaya-sys merged commit d7c44e7 into main Dec 22, 2025
3 checks passed
@sujaya-sys sujaya-sys deleted the dns-assertions branch December 22, 2025 13:00
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.

6 participants