Skip to content

The documentation moves from docs.ctrlrun.dev to ctrlrun.dev - #95

Merged
arpanghoshal merged 3 commits into
mainfrom
docs/apex-domain
Sep 6, 2026
Merged

The documentation moves from docs.ctrlrun.dev to ctrlrun.dev#95
arpanghoshal merged 3 commits into
mainfrom
docs/apex-domain

Conversation

@arpanghoshal

Copy link
Copy Markdown
Contributor

The site becomes the apex domain rather than a subdomain of it. Every reference to the host follows — README, pyproject project URLs, the badge targets and soak qualifier in the generators (and their generated blocks), the share-image URLs in docs.json, the MCP endpoint in the two pages that give it, and the constant test_docs_seo checks the share image against. 29 substitutions, 11 files, no path changes.

Draft until https://ctrlrun.dev serves. Merged early, the README on GitHub and the project URL on PyPI would point at a hostname that currently times out. Order:

  1. ctrlrun.dev added as the custom domain on the Mintlify deployment; verification TXT records green; the parking A record at the apex replaced with ALIAS @ → cname.mintlify.builders.
  2. curl -sI https://ctrlrun.dev/get-started/quickstart returns 200 with a valid certificate.
  3. Mark ready and merge. The Mintlify deploy then rebuilds with the new share-image URLs.
  4. Remove docs.ctrlrun.dev from the deployment's custom domains and point the docs host at a 301 to https://ctrlrun.dev/, path-preserving.

Not set: a site-wide canonical. test_docs_seo records why — a docs.json metatag is stamped on every page, so it would declare all of them duplicates of the home page. Mintlify's per-page canonical is the right one and it follows the domain by itself.

Checks: scripts/check.sh under a fresh venv with [dev,gateway,otel,identity,postgres] — ruff format, ruff check, mypy --strict, 3914 passed / 45 skipped. All nine tools/docs_audit/render_*.py --check pass.

The site becomes the apex domain rather than a subdomain of it, and everything that
names the host follows: the README, the project URLs in pyproject, the two badge
targets and the soak qualifier in the generators, the share-image URLs in docs.json,
the MCP endpoint in the two pages that give it, and the constant the SEO test checks
the share image against. Paths are unchanged, so nothing here is a redirect; the old
hostname redirects at DNS.

No site-wide canonical is set, for the reason test_docs_seo already records: a metatag
in docs.json is stamped on every page, so it would declare all of them duplicates of
the home page. The per-page canonical Mintlify emits is the right one.
@mintlify

mintlify Bot commented Sep 6, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated
ctrlrun 🟢 Ready View Preview Sep 6, 2026, 5:56 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

@arpanghoshal
arpanghoshal enabled auto-merge (squash) September 6, 2026 18:08
@arpanghoshal
arpanghoshal merged commit 2426d46 into main Sep 6, 2026
11 checks passed
@arpanghoshal
arpanghoshal deleted the docs/apex-domain branch September 6, 2026 20:53
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.

1 participant