Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .claude/skills/guide-authoring/SKILL.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: guide-authoring
description: Write or rewrite a page in the Guides tab. Use whenever a task touches guides/*.mdx, samples/guides/, or images/guides/. Covers the fixed page template (collapsed agent prompt, then CLI steps), the tested-sample and screenshot pipeline, brand diagram rules, and the verification checklist.

Check warning on line 3 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L3

Use parentheses judiciously.

Check warning on line 3 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L3

Use 'command-line tool' instead of 'CLI'.
metadata:
author: checkly docs
established: 2026-09-23
Expand All @@ -8,71 +8,73 @@

# Guide authoring

A guide is a tutorial that uses Checkly in a real-world scenario that ends with something being deployed. It has one job, takes 15 to 30 minutes, walks the reader through the scenario, holding their hand from start to finish. Where Docs are atomic details of each feature, and Learn teaches users about best practices and product-agnostic processes, Guides brings them all together to "get real jobs done".

Check warning on line 11 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L11

Try to avoid using 'is'.

Check warning on line 11 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L11

Did you really mean 'Checkly'?

Check warning on line 11 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L11

In general, use active voice instead of passive voice ('being deployed').

Check warning on line 11 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L11

Try to avoid using 'being'.

Check warning on line 11 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L11

'being deployed' may be passive voice. Use active voice if you can.

Check warning on line 11 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L11

Try to avoid using 'are'.

Check warning on line 11 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L11

Commas and periods go inside quotation marks.

## Non-negotiables

1. **MCP and the CLI lead.** Every guide offers a collapsed prompt the reader can hand to their coding agent with Checkly Skills installed. The manual steps that follow use `npx checkly` for every action. Guides in Resolve and Communicate also show the MCP server doing the reading (results, RCA, incidents). The web app is a place to look, never the place to configure.

Check warning on line 15 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L15

Spell out 'MCP', if it's unfamiliar to the audience.

Check warning on line 15 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L15

Use 'command-line tool' instead of 'CLI'.

Check warning on line 15 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L15

Did you really mean 'Checkly'?

Check warning on line 15 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L15

Spell out 'MCP', if it's unfamiliar to the audience.

Check warning on line 15 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L15

Use parentheses judiciously.

Check warning on line 15 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L15

Spell out 'RCA', if it's unfamiliar to the audience.

Check warning on line 15 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L15

Try to avoid using 'is'.
2. **Every code block is copied verbatim from a sample that passed on Checkly.** No untested code, no placeholder URLs, no `runtimeId` pins.

Check warning on line 16 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L16

'is copied' may be passive voice. Use active voice if you can.

Check warning on line 16 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L16

Try to avoid using 'is'.

Check warning on line 16 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L16

In general, use active voice instead of passive voice ('is copied').

Check warning on line 16 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L16

Did you really mean 'Checkly'?
3. **Screenshots start as the guide's own deployed checks.** Recreate the screenshot as a PNG or piece of code to get it into the perfect state for the guide, but do not "invent" any features, buttons, or capabailities. Remove account and user chrome, while

Check warning on line 17 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L17

Spell out 'PNG', if it's unfamiliar to the audience.

Check warning on line 17 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L17

Use 'don't' instead of 'do not'.

Check warning on line 17 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L17

Did you really mean 'capabailities'?
4. **Diagrams follow the brand system** (see "Diagrams"). Diagrams should be used to distill and visualize information that would otherwise be unparseable in text, or too much text.

Check warning on line 18 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L18

Use parentheses judiciously.

Check warning on line 18 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L18

Try to avoid using 'be'.

Check warning on line 18 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L18

'be used' may be passive voice. Use active voice if you can.

Check warning on line 18 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L18

In general, use active voice instead of passive voice ('be used').

Check warning on line 18 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L18

Try to avoid using 'be'.

Check warning on line 18 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L18

Did you really mean 'unparseable'?
5. **Be Concise** If the tutorial is approaching 3000+ words, think about splitting rather than exceeding.

Check warning on line 19 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L19

Try to avoid using 'Be'.

Check warning on line 19 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L19

Try to avoid using 'is'.

## Page template

Fixed order. Do not add sections; fold extra material into a step or cut it.

Check warning on line 23 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L23

Use 'don't' instead of 'Do not'.

Check warning on line 23 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L23

Use semicolons judiciously.

1. **Frontmatter**: `title`, `sidebarTitle`, `description`, `canonical`. Nothing else.

Check warning on line 25 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L25

Did you really mean 'Frontmatter'?
2. **Outcome**: one sentence starting "By the end of this guide", then a `<Frame>` with the end-state screenshot.

Check warning on line 26 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L26

Commas and periods go inside quotation marks.
3. **Sample**: one plain sentence linking the sample under `samples/guides/<slug>/` and what it monitors. No Prerequisites accordion.
4. **Let your agent do it**, collapsed in `<Accordion title="Let your agent do it" icon="sparkles">` right after the sample sentence, with no `##` heading: `import GuideAgentIntro from '/snippets/guide-agent-intro.mdx'` and `import { CopyPromptButton } from '/snippets/copy-prompt-button.jsx'`. Render `<GuideAgentIntro />`, then the prompt inside `<div id="ai-setup-prompt">` as a ` ```txt ` block, then `<CopyPromptButton />`, then one sentence: the steps below are what the agent does, in the open. The prompt states the goal, the success criteria, and that the agent must run `npx checkly test --record` and stop for confirmation before `npx checkly deploy`. The prompt carries the gist of the guide and nothing about skills. The snippet links to [Checkly Skills](/ai/skills); never add install or `npx checkly skills` instructions to the page. `npx checkly init` in the quickstart already installs the skill, so every reader has it.

Check warning on line 28 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L28

Use 'command-line tool' instead of 'CLI'.

Check warning on line 28 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L28

Spell out 'MCP', if it's unfamiliar to the audience.
5. **Use Realistic Code** Each "do this, code block, what you see". Code fences carry the filename. CLI steps show real captured output in a ` ```text Terminal ` fence. Where the app changes, a `<Frame>` screenshot. Browser monitoring shows Playwright Check Suites and Browser Checks as equal paths in a `<CodeGroup>`.

Check warning on line 29 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L29

Did you really mean 'Checkly'?

Check warning on line 29 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L29

Spell out 'MCP', if it's unfamiliar to the audience.

Check warning on line 29 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L29

Spell out 'MCP', if it's unfamiliar to the audience.

Check warning on line 29 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L29

Try to avoid using 'are'.
6. **Verify it works**: force a failure or run `npx checkly trigger`, show the result. In Resolve and Communicate guides, also show the same check through the MCP server with a ` ```text Prompt ` example.
7. **Next**: one link to the guide that follows this one in the sidebar order, with a sentence on why.
8. **Reference**: bullet list of the product pages touched. Link [Checkly Skills](/ai/skills) once; add the MCP tools page when MCP appears. No `npx checkly skills` instructions anywhere on the page.

Check warning on line 32 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L32

Did you really mean 'devDependencies'?

Check warning on line 32 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L32

Did you really mean 'repo'?

Headings: the `##` sections between the accordion and "Verify it works" are named for what the reader does, never numbered. No "Step N:" prefixes anywhere in a heading.

Voice: second person, plain sentences, no em dashes, no parentheticals. Tips and Notes sparingly, one each at most per step. Avoid any AI-slop.

Check warning on line 36 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L36

Use parentheses judiciously.

## Sample pipeline

- `samples/guides/<slug>/` is a self-contained project: `package.json` with `checkly` and `@playwright/test` as devDependencies, `checkly.config.ts` with `projectName: 'Docs guide: <title>'` and `logicalId: 'docs-guide-<slug>'`, and the check files. Never under `__checks__` at the repo root; the root `checkly.config.ts` ignores `samples/**` for this reason.

Check warning on line 40 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L40

Did you really mean 'Checkly'?

Check warning on line 40 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L40

Use parentheses judiciously.

Check warning on line 40 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L40

Did you really mean 'gitignored'?
- Demo targets: the Danube shop at `https://danube-web.shop` (hosted in `us-east-1`, API at `/api/books`) and `httpbin.org`. Checkout on Danube needs the "Company (optional)" field filled.

Check warning on line 41 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L41

Did you really mean 'Checkly'?
- From the sample folder, with the repo `.env` sourced: `npx checkly test --record --test-session-name "Docs guide: <title>"`, then `npx checkly deploy --force`. Both deploy to the Checkly Marketing account. Keep `.captures/` (gitignored) with the raw terminal output you paste into the guide.

Check warning on line 42 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L42

Did you really mean 'const'?
- `checkly test --grep` matches the check **name**, not the logical ID.

Check warning on line 43 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L43

Use parentheses judiciously.

Check warning on line 43 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L43

Did you really mean 'gitignored'?
- Playwright Check Suites bundle from the directory of `playwright.config.ts` using the nearest `package.json`.

## Screenshot pipeline

Check warning on line 46 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L46

Did you really mean 'viewport'?

Uses the harness in `scripts/guides/screenshots/`. It defaults to the Checkly Marketing account at 2x.

Check warning on line 48 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L48

Spell out 'PNG', if it's unfamiliar to the audience.

Check warning on line 48 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L48

Be careful with 'Reject', it's profane in some cases.

1. Add scenes tagged `guide-<slug>` to `scripts/guides/screenshots/scenes.ts`; keep IDs in a `GUIDE_<NAME>` const. Test-session and result IDs age out of retention; re-record and update when a capture comes back empty.
2. `npm run guides:screenshots -- --tags=guide-<slug>`. Light theme only. Captures land in `scripts/guides/screenshots/output/images/` (gitignored).
3. Clip to the app content: `clip: { x: 240, y: 58, width: 1200, height: <n> }` drops the sidebar and top bar, which carry the account and user name. Use a tall viewport instead of `fullPage` on scrolling panes.

Check warning on line 52 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L52

Use 'doesn't' instead of 'does not'.
4. Open every PNG before use. Reject skeleton states, empty states, and any user name, email, or other customers' resources. The Projects page shows other people's repositories; never capture it.

Check warning on line 53 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L53

Use 'can't' instead of 'cannot'.

Check warning on line 53 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L53

Try to avoid using 'be'.
5. Copy to `images/guides/<slug>/<step>.png`. Embed in `<Frame><img src alt /></Frame>` with alt text describing the state.

Known routes: check detail `/checks/<id>`, group `/groups/<id>`, test session `/test-sessions/<id>`, home list search `/?search=<text>`. Expanding group rows on the home list by click does not work; capture the group page.

Check warning on line 56 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L56

Did you really mean 'callout'?

Check warning on line 56 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L56

Try to avoid using 'is'.

If the saved session has expired the capture lands on a login page. Ask Dan to run `npm run guides:screenshots:auth`; it cannot be done non-interactively.

Check warning on line 58 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L58

Use parentheses judiciously.

Check warning on line 58 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L58

Did you really mean 'equirectangular'?

## Diagrams

Only draw what has a spatial or quantitative idea: maps, timelines, bars, coverage spans. Three text cards in a grid is page content, written as bold-led paragraphs or a list.

Check warning on line 62 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L62

Spell out 'PNG', if it's unfamiliar to the audience.

Check warning on line 62 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L62

Use 'can't' instead of 'cannot'.

Check warning on line 62 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L62

Try to avoid using 'is'.

- Card: deep-blue gradient `#041734` to `#0A2A55`, corner radius 20, border `rgba(120,150,185,0.34)`. Title Inter 24 weight 500 letter-spacing -0.04em, subtitle `#A7B8CB`, one blue callout footer for the takeaway.

Check warning on line 64 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L64

Spell out 'PNG', if it's unfamiliar to the audience.
- Colors: green `#20DF66`, yellow `#FFBD00`, red `#FF5C5C`, brand blue `#0075FF`. Region IDs in JetBrains Mono.
- World maps: dot matrix from Natural Earth land polygons (world-atlas plus d3-geo), equirectangular, latitude 72 to -58, dots `rgba(139,163,199,0.30)`.
- Ship PNG at 2x rendered with Playwright and Google Fonts Inter. An SVG in an `img` tag cannot use the page's web font.
- Generators live in `scripts/guides/diagrams/<slug>/`, one script per image, named after the PNG. Import the brand helpers from `scripts/guides/diagrams/lib.mjs`; its `write()` renders straight to `images/guides/<slug>/`. Commit the generator with the image.

Check warning on line 68 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L68

Use 'don't' instead of 'Do not'.

Check warning on line 68 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L68

Try to avoid using 'are'.
- Real data beats illustration. Pull per-location results from `GET /v1/check-results/<checkId>` and chart the medians.

Check warning on line 69 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L69

'PR conventions' should use sentence-style capitalization.

## Verification before commit

- `npx checkly test` passes from the sample; `npx checkly deploy --force` done; root `npx checkly deploy --preview` still lists only the docs-site resources.
- `./node_modules/.bin/mint broken-links` clean. Move `.context/attachments` aside first; the Conductor comment files there break the MDX parser. Do not start `mint dev` or open a browser to eyeball pages; the link check and reading the MDX are enough.

Check warning on line 74 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L74

Did you really mean 'repo'?
- `wc -w` under 2,000.
- A cold read from the quickstart completes the guide without opening another guide first.

## PR conventions

One PR per guide, or a series on one branch. Each commit: the MDX, its sample, its images, its redirects, its overview card, and repointed inbound links. A retired page gets a `docs.json` redirect and every inbound link repointed in the same commit. Update the PR body with `gh api -X PATCH repos/checkly/docs/pulls/<n>`; `gh pr edit` fails on this repo.

Check warning on line 80 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L80

Spell out 'MDX', if it's unfamiliar to the audience.

Check warning on line 80 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L80

Did you really mean 'repointed'?

Check warning on line 80 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L80

Did you really mean 'repointed'?

Check warning on line 80 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L80

Use semicolons judiciously.

Check warning on line 80 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L80

Try to avoid using 'is'.

Check warning on line 80 in .claude/skills/guide-authoring/SKILL.md

View check run for this annotation

Mintlify / Mintlify Validation (checkly-422f444a) - vale-spellcheck

.claude/skills/guide-authoring/SKILL.md#L80

Did you really mean 'repo'?
61 changes: 0 additions & 61 deletions GUIDES-PLAN.md

This file was deleted.

5 changes: 3 additions & 2 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -1116,15 +1116,16 @@
"guides/overview",
"guides/structuring-a-checkly-project",
"guides/playwright-testing-to-monitoring",
"guides/agentic-workflows"
"guides/agentic-workflows",
"guides/global-monitoring"
]
},
{
"group": "Detect",
"pages": [
"guides/uptime-monitoring",
"guides/api-monitoring",
"guides/keyword-monitoring",
"guides/global-monitoring",
"guides/sdlc-monitoring",
"guides/setup-scripts-for-apis"
]
Expand Down
Loading
Loading