Skip to content

docs: close the status pages v3 gaps from support's review (DOC-240) - #739

Merged
hlenke merged 2 commits into
mainfrom
docs-audit/doc-240-status-pages-v3-gaps
Oct 29, 2026
Merged

hlenke merged 2 commits into
mainfrom
docs-audit/doc-240-status-pages-v3-gaps

Conversation

@hlenke

@hlenke hlenke commented Oct 28, 2026

Copy link
Copy Markdown
Member

Fixes DOC-240.

Support (Angie, via Shawn) reviewed the status pages v3 docs and found 8 gaps. I checked each one against the released CLI (10.0.0), the Checkly app and the public status page app, then fixed the docs with small, targeted edits.

What changed

  1. Broken custom domain links. Three pages linked to a "custom domain" section of the customization guide that doesn't exist. They now point to the Custom domain page.
  2. Broken backfilling links. Two links on the incidents page pointed to a "Backfilling an incident" section that doesn't exist. The step now names the real setting (Use custom date to backfill incident under Public date), and the other link points to the steps for creating an incident.
  3. Header and footer links (support, footer text, privacy policy, terms of service). These were missing from the customization guide and are now listed with the labels the app uses. The construct reference also said the support link is in the footer, but it's actually a "Contact Support" link in the page header. That's fixed too.
  4. Google Analytics tag. Added to the customization guide.
  5. Search indexing. Added to the customization guide, with a note that turning it off asks search engines not to list the page but doesn't restrict access.
  6. Component display options. You can hide a component's historical data and show a group expanded when the page loads. These are now in the overview and in the StatusPageV3Component reference, which didn't list them at all.
  7. Automation rule cool down. coolDownMinutes must be a non-negative integer.
  8. Automation rule components. They must belong to the rule's own status page.

I also found one more rule while testing: a group needs at least one component. It's now in the overview and the component reference.

How it was proven

Claim Proof
All page settings (support, footer, privacy, terms, GA tag, indexing) Deployed a v3 page with CLI 10.0.0 to a local Checkly stack and read every value back through the v3 API
Defaults: historical data shown, groups collapsed API readback shows showHistoricalData: true and expandedByDefault: false when they're not set
Where things render Rendered the page in the local status page app. "Contact Support" is in the header, the footer text and privacy and terms links are in the footer, the GA tag is in the scripts, and noindex is in the robots meta tag. The component without history shows no bar or percentage, and only the expanded group's child is visible on load
Cool down and same-page rules CLI 10.0.0 rejects coolDownMinutes: -1 and 1.5 ("Value must be a non-negative integer") and a component from another page ("belongs to another status page than this rule"). 0 is accepted
A group needs a component The first deploy failed with "A group needs at least one component"
UI labels Taken from the webapp's status page editor and its English strings

npm run check:links and vale pass. An independent reviewer checked the diff against the code. I applied its fixes: removed an overstated "bar and percentage" wording, fixed the support link location, and replaced an invented footer example.

Not changed

  • The Header Text field in the same settings card. It isn't one of the 8 gaps, and I didn't verify how it renders.
  • One product detail worth a look: for a service inside a group, the uptime percentage follows the group's historical-data setting, not the service's own. The service's own setting only hides its bar. The docs don't go into this.

🤖 Generated with Claude Code

- Fix dead links to customization#custom-domain and incidents#backfilling-an-incident.
- Customization: document the Header & Footer links and the SEO & analytics settings.
- Overview and StatusPageV3Component: document showHistoricalData and expandedByDefault,
  and that a group needs at least one component.
- StatusPageV3AutomationRule: coolDownMinutes must be a non-negative integer, and
  components must belong to the rule's status page.
- StatusPageV3: the support link is shown in the page header, not the footer.

Verified with CLI 10.0.0 against a local stack, API readback and the rendered page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
checkly-422f444a 🟢 Ready View Preview Oct 28, 2026, 7:33 PM

Comment thread communicate/status-pages/customization.mdx Outdated
…C-240)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@hlenke
hlenke merged commit 50e0d85 into main Oct 29, 2026
9 checks passed

This branch was successfully deployed

1 active deployment
staging — a4d0913e Deployed Oct 28, 2026 by mintlify[bot]
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.

2 participants