Skip to content

docs: redesign the docs homepage as an agent-first landing page - #585

Closed
Dgiordano33 wants to merge 6 commits into
mainfrom
Dgiordano33/tavily-docs-homepage-create
Closed

Dgiordano33 wants to merge 6 commits into
mainfrom
Dgiordano33/tavily-docs-homepage-create

Conversation

@Dgiordano33

Copy link
Copy Markdown
Collaborator

Rebuilds index.mdx as a landing page modeled on docs.tavily.com, in Checkly's voice: a deep-blue hero with the Monitoring as Code pitch, npx checkly init for agent setup, tested check samples with test/deploy, Detect/Communicate/Resolve cards, developer resources, and the Playwright sign-up CTA. The page uses mode: frame (custom layout, sidebar kept) and <Visibility> to serve a plain Markdown version to AI agents. Styles live in style.css as home-* classes rather than Tailwind utilities. Bumps the mint CLI to 4.2.1031 because 4.2.259 doesn't know <Visibility> and rendered the page empty in mint dev.

Affected Components

  • Docs

Notes for the Reviewer

  • The three runnable code samples (URL Monitor, API Check, Browser Check) passed npx checkly test; the Heartbeat sample type-checks and passes project validation. npx mint broken-links and openapi-check pass on the new CLI.
  • The API sample uses /v1/runtimes because api.checklyhq.com/hello (used in constructs/api-check.mdx) now returns 404. That page isn't fixed here.
  • Please check the hero in light mode and on mobile widths in the preview deployment.

New Dependency Submission

mint dev dependency bumped from 4.2.259 to 4.2.1031 for <Visibility> support. This is why package-lock.json is large.

🤖 Generated with Claude Code

Dgiordano33 and others added 4 commits October 13, 2026 23:25
Custom-mode homepage modeled on docs.tavily.com: hero, agent onboarding
with npx checkly init, CLI and skills install, tested Try it now tabs,
platform and developer resource cards. Agents get a Markdown version
via <Visibility for="agents">.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The homepage uses <Visibility>, which mint 4.2.259 doesn't know, so
mint dev rendered the page empty.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Deep-blue hero with the raccoon mark and the Monitoring as Code pitch,
blue eyebrows, section copy around test/deploy and Detect/Communicate/
Resolve, and the Playwright sign-up CTA at the end.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Switch from custom to frame page mode, which keeps the sidebar
navigation alongside the custom layout.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Oct 19, 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 19, 2026, 3:45 PM

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

@hlenke hlenke left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Recommend closing · Superseded by #586 (merged 2026-10-28), which already shipped a redesigned homepage on main; this branch now conflicts with it in every file and its CI fails at npm ci.

Why close

  • Superseded. main already has the same approach this PR introduces: mode: "frame", sidebarTitle: 'Home', a <Visibility for="agents"> Markdown block plus a <Visibility for="humans"> layout, home-* classes in style.css, and mint at 4.2.1031 in package.json. That landed in #586 ("docs: redesign the docs homepage after the Cloudflare developer docs layout", 2bdaf05) and more than 20 follow-up commits to index.mdx through 2026-10-29 (Rocky AI tab, monitoring use cases, What's new cards, copy-prompt button, the waves image in ec6aaca).
  • Conflicts. GitHub reports mergeable: CONFLICTING / mergeStateStatus: DIRTY. Both branches rewrote index.mdx from the same base and both appended a /* Docs homepage ... */ block with different .home* rules at the end of style.css. Resolving it means picking one design. Merging this one would undo #586.
  • CI fails. static-docs-checks and preview-checks both stop at npm ci: "npm ci can only install packages when your package.json and package-lock.json ... are in sync", starting with "lock file's @mintlify/link-rot@3.0.1453 does not satisfy @mintlify/link-rot@3.0.803" and then a long list of Missing: ... from lock file. The 6,508-line package-lock.json regeneration for the mint bump does not match the package.json it is tested against. main has made that bump already, so this PR does not need to change package.json or package-lock.json at all.

Worth carrying over (optional, as a small PR against main's page)

If any of this PR's content should survive, open a focused PR against the current index.mdx:

  • The API check, URL monitor, and Heartbeat monitor samples. main's Detect tab shows only the Playwright spec. The PR description says the API and URL samples passed npx checkly test. I did not rerun them here.
  • The closing Playwright sign-up CTA (sign-up-cta), which main's homepage does not have.

Related, outside this PR: the PR description says api.checklyhq.com/hello returns 404. That still holds (I got a 404 today), and constructs/api-check.mdx:38 on main still uses it. That example needs its own fix.

No inline comments: the changed lines would be replaced wholesale by a rebase, so line-level wording notes would not help.

What I checked
  • Diffed the PR from its merge base e0f6dd3a (git diff <base> refs/docs-review/pr-585 -- index.mdx style.css package.json). Read every changed line of index.mdx, style.css, and package.json. I did not review package-lock.json line by line; it is a generated lockfile and CI shows it is out of sync.
  • Diffed main against the same base for those files, and listed git log <base>..origin/main -- index.mdx (#586 and its follow-ups). Found the merged PR with gh pr list --state merged --search 2bdaf050.
  • gh pr view 585 --json mergeable,mergeStateStatus: CONFLICTING / DIRTY.
  • gh pr checks 585: static-docs-checks and preview-checks fail; Mintlify Deployment, link-rot, vale-spellcheck, and docs-gate pass. Read both failure logs with gh run view --log-failed (runs 39280282495 and 39280282452): both fail at npm ci with lockfile/package.json drift.
  • Editing rules: the PR's style.css additions contain no url(), and the PR adds no .js files under content directories.
  • Overlap: no other open non-draft PR touches index.mdx, style.css, or the package files. The file list for draft #774 (369 files) was truncated, so I did not check it.
  • curl https://api.checklyhq.com/hello → 404. git grep found it at constructs/api-check.mdx:38 on origin/main.
  • Not run: no end-to-end tests. I recommend closing, so the samples' behavior does not affect the verdict.

@Dgiordano33 Dgiordano33 closed this Nov 4, 2026

This branch was successfully deployed

1 active deployment
staging — 6d0cfe64 Deployed Oct 19, 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