Repository navigation
docs: redesign the docs homepage as an agent-first landing page - #585
Closed
Dgiordano33 wants to merge 6 commits into
Closed
Dgiordano33 wants to merge 6 commits into
Dgiordano33 wants to merge 6 commits into
Conversation
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>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
1 task done
hlenke
reviewed
Nov 3, 2026
hlenke
left a comment
Member
There was a problem hiding this comment.
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.
mainalready 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 instyle.css, andmintat4.2.1031inpackage.json. That landed in #586 ("docs: redesign the docs homepage after the Cloudflare developer docs layout", 2bdaf05) and more than 20 follow-up commits toindex.mdxthrough 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 rewroteindex.mdxfrom the same base and both appended a/* Docs homepage ... */block with different.home*rules at the end ofstyle.css. Resolving it means picking one design. Merging this one would undo #586. - CI fails.
static-docs-checksandpreview-checksboth stop atnpm ci: "npm cican 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 ofMissing: ... from lock file. The 6,508-linepackage-lock.jsonregeneration for themintbump does not match thepackage.jsonit is tested against.mainhas made that bump already, so this PR does not need to changepackage.jsonorpackage-lock.jsonat 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 passednpx checkly test. I did not rerun them here. - The closing Playwright sign-up CTA (
sign-up-cta), whichmain'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 ofindex.mdx,style.css, andpackage.json. I did not reviewpackage-lock.jsonline by line; it is a generated lockfile and CI shows it is out of sync. - Diffed
mainagainst the same base for those files, and listedgit log <base>..origin/main -- index.mdx(#586 and its follow-ups). Found the merged PR withgh pr list --state merged --search 2bdaf050. gh pr view 585 --json mergeable,mergeStateStatus: CONFLICTING / DIRTY.gh pr checks 585:static-docs-checksandpreview-checksfail; Mintlify Deployment, link-rot, vale-spellcheck, and docs-gate pass. Read both failure logs withgh run view --log-failed(runs 39280282495 and 39280282452): both fail atnpm ciwith lockfile/package.json drift.- Editing rules: the PR's
style.cssadditions contain nourl(), and the PR adds no.jsfiles 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 grepfound it atconstructs/api-check.mdx:38onorigin/main.- Not run: no end-to-end tests. I recommend closing, so the samples' behavior does not affect the verdict.
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rebuilds
index.mdxas a landing page modeled on docs.tavily.com, in Checkly's voice: a deep-blue hero with the Monitoring as Code pitch,npx checkly initfor agent setup, tested check samples withtest/deploy, Detect/Communicate/Resolve cards, developer resources, and the Playwright sign-up CTA. The page usesmode: frame(custom layout, sidebar kept) and<Visibility>to serve a plain Markdown version to AI agents. Styles live instyle.cssashome-*classes rather than Tailwind utilities. Bumps themintCLI to 4.2.1031 because 4.2.259 doesn't know<Visibility>and rendered the page empty inmint dev.Affected Components
Notes for the Reviewer
npx checkly test; the Heartbeat sample type-checks and passes project validation.npx mint broken-linksandopenapi-checkpass on the new CLI./v1/runtimesbecauseapi.checklyhq.com/hello(used inconstructs/api-check.mdx) now returns 404. That page isn't fixed here.New Dependency Submission
mintdev dependency bumped from 4.2.259 to 4.2.1031 for<Visibility>support. This is whypackage-lock.jsonis large.🤖 Generated with Claude Code