Skip to content

docs: technical SEO cleanup for CLI pages, titles, and links#3986

Merged
d-cs merged 9 commits into
mainfrom
docs/seo-audit-fixes
Jun 18, 2026
Merged

docs: technical SEO cleanup for CLI pages, titles, and links#3986
d-cs merged 9 commits into
mainfrom
docs/seo-audit-fixes

Conversation

@D-K-P

@D-K-P D-K-P commented Jun 18, 2026

Copy link
Copy Markdown
Member

A batch of technical-SEO fixes across the docs, all reader-facing (titles, links, redirects):

  • Canonicalize the duplicate CLI command pages: the bare /cli-dev and /cli-deploy paths now permanently redirect to their -commands equivalents, and a duplicate navigation entry is removed.
  • Give the three pages that all rendered as "Overview" distinct titles (Building with AI, self-hosting overview, Management API overview), with sidebar labels unchanged.
  • Replace the generic "Learn more" links in the introduction's build-extension list with descriptive anchor text.
  • Switch two http links to https in the Supabase guides, point a troubleshooting page's help link to Discord, and add missing meta descriptions to three help and troubleshooting pages.

@changeset-bot

changeset-bot Bot commented Jun 18, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 41d9213

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 3ae53bc1-3584-48f2-86a9-ceb4b417e00e

📥 Commits

Reviewing files that changed from the base of the PR and between b74a141 and 2161c0b.

📒 Files selected for processing (24)
  • docs/building-with-ai.mdx
  • docs/cli-deploy.mdx
  • docs/cli-dev.mdx
  • docs/cli-development-commands.mdx
  • docs/deploy-environment-variables.mdx
  • docs/deployment/overview.mdx
  • docs/docs.json
  • docs/guides/example-projects/anchor-browser-web-scraper.mdx
  • docs/guides/examples/libreoffice-pdf-conversion.mdx
  • docs/guides/examples/replicate-image-generation.mdx
  • docs/guides/frameworks/supabase-edge-functions-basic.mdx
  • docs/guides/frameworks/supabase-edge-functions-database-webhooks.mdx
  • docs/help-slack.mdx
  • docs/introduction.mdx
  • docs/management/overview.mdx
  • docs/open-source-self-hosting.mdx
  • docs/self-hosting/overview.mdx
  • docs/snippets/deplopying-your-task.mdx
  • docs/snippets/useful-next-steps.mdx
  • docs/tasks/scheduled.mdx
  • docs/troubleshooting-debugging-in-vscode.mdx
  • docs/troubleshooting-github-issues.mdx
  • docs/troubleshooting-uptime-status.mdx
  • docs/video-walkthrough.mdx
💤 Files with no reviewable changes (3)
  • docs/cli-dev.mdx
  • docs/cli-development-commands.mdx
  • docs/cli-deploy.mdx
✅ Files skipped from review due to trivial changes (15)
  • docs/help-slack.mdx
  • docs/snippets/useful-next-steps.mdx
  • docs/open-source-self-hosting.mdx
  • docs/guides/example-projects/anchor-browser-web-scraper.mdx
  • docs/deploy-environment-variables.mdx
  • docs/guides/examples/replicate-image-generation.mdx
  • docs/building-with-ai.mdx
  • docs/snippets/deplopying-your-task.mdx
  • docs/troubleshooting-uptime-status.mdx
  • docs/guides/frameworks/supabase-edge-functions-database-webhooks.mdx
  • docs/guides/frameworks/supabase-edge-functions-basic.mdx
  • docs/guides/examples/libreoffice-pdf-conversion.mdx
  • docs/troubleshooting-github-issues.mdx
  • docs/self-hosting/overview.mdx
  • docs/tasks/scheduled.mdx
🚧 Files skipped from review as they are similar to previous changes (4)
  • docs/video-walkthrough.mdx
  • docs/troubleshooting-debugging-in-vscode.mdx
  • docs/introduction.mdx
  • docs/docs.json
📜 Recent review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Analyze (javascript-typescript)
🧰 Additional context used
📓 Path-based instructions (1)
docs/**/*.mdx

📄 CodeRabbit inference engine (docs/CLAUDE.md)

docs/**/*.mdx: MDX documentation pages must include frontmatter with title (required), description (required), and sidebarTitle (optional) in YAML format
Use Mintlify components for structured content: , , , , , , /, /
Always import from @trigger.dev/sdk in code examples (never from @trigger.dev/sdk/v3)
Code examples must be complete and runnable where possible
Use language tags in code fences: typescript, bash, json

Files:

  • docs/management/overview.mdx
  • docs/deployment/overview.mdx
🧠 Learnings (3)
📚 Learning: 2026-03-10T12:44:14.176Z
Learnt from: nicktrn
Repo: triggerdotdev/trigger.dev PR: 3200
File: docs/config/config-file.mdx:353-368
Timestamp: 2026-03-10T12:44:14.176Z
Learning: In the trigger.dev repo, docs PRs are often companions to implementation PRs. When reviewing docs PRs (MDX files under docs/), check the PR description for any companion/related PR references and verify that the documented features exist in those companion PRs before flagging missing implementations. This ensures docs stay in sync with code changes across related PRs.

Applied to files:

  • docs/management/overview.mdx
  • docs/deployment/overview.mdx
📚 Learning: 2026-04-30T20:30:29.458Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3226
File: docs/ai-chat/quick-start.mdx:13-13
Timestamp: 2026-04-30T20:30:29.458Z
Learning: In this repo’s documentation MDX files (`docs/**/*.mdx`), use `ts` and `tsx` (not `typescript`) as the code-fence language tags for TypeScript/TSX snippets. Do not flag `ts`/`tsx` code-fence language tags as incorrect in any docs MDX file, since this is the site-wide Mintlify-compatible convention.

Applied to files:

  • docs/management/overview.mdx
  • docs/deployment/overview.mdx
📚 Learning: 2026-06-14T17:36:56.078Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3942
File: docs/management/sessions/create.mdx:1-4
Timestamp: 2026-06-14T17:36:56.078Z
Learning: In trigger.dev docs, MDX pages under `docs/management/` that include an `openapi:` key in their frontmatter are intentional OpenAPI-driven reference stubs (typically `title` + `openapi` only). The page description is rendered from the referenced OpenAPI operation, so do not flag missing `description` frontmatter on these pages.

Applied to files:

  • docs/management/overview.mdx
🪛 LanguageTool
docs/deployment/overview.mdx

[style] ~9-~9: For conciseness, consider replacing this expression with an adverb.
Context: ...loy your tasks. The only way to do this at the moment is through the [deploy CLI command](/cl...

(AT_THE_MOMENT)

🔇 Additional comments (3)
docs/deployment/overview.mdx (1)

9-9: LGTM!

docs/management/overview.mdx (2)

2-2: LGTM!


40-40: LGTM!


Walkthrough

This PR renames CLI documentation routes from /cli-dev and /cli-deploy to /cli-dev-commands and /cli-deploy-commands. The old MDX page files are emptied, the "Development" navigation group is removed from docs.json, and three redirect rules are added for backward compatibility. All internal links across snippets, task docs, deployment guides, and overview pages are updated to the new routes. Additionally, several page titles are made more specific, missing description frontmatter fields are added to troubleshooting and help pages, two Supabase guide URLs are corrected from HTTP to HTTPS, a GitHub issues link is replaced with a Discord URL, the build-extension table in the introduction gains per-extension documentation links, and external URLs for Anchor Browser and LibreOffice guides are updated.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description provides detailed information about the changes including canonicalization, page titles, link improvements, and metadata, but does not follow the repository's required template structure. Restructure the description to follow the template: include 'Closes #', checklist items, Testing section, Changelog, and Screenshots sections as specified.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main changes: technical SEO improvements to CLI pages, titles, and links across the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/seo-audit-fixes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

devin-ai-integration[bot]

This comment was marked as resolved.

coderabbitai[bot]

This comment was marked as resolved.

devin-ai-integration[bot]

This comment was marked as resolved.

D-K-P added 8 commits June 18, 2026 12:41
Three pages shared the title "Overview"; give building-with-ai,
self-hosting/overview, and management/overview distinct titles (sidebar
labels unchanged). Replace the generic "Learn more" links in the
introduction build-extension table with descriptive anchor text.
Rewrite two cloud.trigger.dev links from http to https in the Supabase
edge-function guides. Point the troubleshooting page's help link to
Discord instead of GitHub issues. Add missing description frontmatter to
three troubleshooting and help pages.
Add permanent: true to the /cli-development-commands redirect so it
returns a 301 like the other deleted CLI pages. Fix 'succesful' to
'successful' in the Supabase edge functions guide.
Update three 404'd external links to their current URLs: the Replicate
nano-banana model, the LibreOffice download page, and the Anchor Browser
docs.
The list example declared `const runs = await runs.list(...)`, which
shadowed the imported `runs` and threw at runtime. Rename the local to
`completedRuns`.
@D-K-P D-K-P force-pushed the docs/seo-audit-fixes branch from 68f3d97 to 2161c0b Compare June 18, 2026 11:42
@d-cs d-cs enabled auto-merge (squash) June 18, 2026 13:03
@d-cs d-cs merged commit e34d524 into main Jun 18, 2026
17 checks passed
@d-cs d-cs deleted the docs/seo-audit-fixes branch June 18, 2026 13:03
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