Skip to content

docs: give docs pages unique title tags and redirect stale pages - #4416

Merged
D-K-P merged 1 commit into
mainfrom
seo-fixes
Jul 29, 2026
Merged

docs: give docs pages unique title tags and redirect stale pages#4416
D-K-P merged 1 commit into
mainfrom
seo-fixes

Conversation

@D-K-P

@D-K-P D-K-P commented Jul 29, 2026

Copy link
Copy Markdown
Member

Summary

Several docs pages rendered identical <title> tags, which weakens search indexing and makes results ambiguous. Each affected page now has a unique, descriptive title while keeping its existing sidebar label unchanged.

Alongside the retitles:

  • Removed two stale build-system upgrade pages that were no longer in the navigation, with redirects to the current package upgrade guide.
  • Redirected the build-extensions group index to its overview page so the two URLs stop sharing a title.
  • Dropped a leftover orphaned API reference page (its old URL already redirects to the management overview).

No links break: nothing in the docs points at the removed pages, and every redirect target exists.

Several docs pages rendered identical <title> tags, which weakens search
indexing. Give each affected page a unique, descriptive title and keep its
existing sidebar label.

Remove two stale build-system upgrade pages that were no longer in the
navigation and redirect their URLs to the current package upgrade guide.
Redirect the build-extensions group index to its overview page so the two
URLs stop sharing a title, and drop a leftover orphaned API reference page.
@changeset-bot

changeset-bot Bot commented Jul 29, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 5d13e98

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 Jul 29, 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 Plus

Run ID: ae51e4b0-ce69-4798-9cda-6606fff85aac

📥 Commits

Reviewing files that changed from the base of the PR and between 15e160d and 5d13e98.

📒 Files selected for processing (13)
  • docs/ai-chat/changelog.mdx
  • docs/ai-chat/how-it-works.mdx
  • docs/bulk-actions.mdx
  • docs/config/extensions/lightpanda.mdx
  • docs/config/extensions/puppeteer.mdx
  • docs/docs.json
  • docs/guides/examples/lightpanda.mdx
  • docs/guides/examples/puppeteer.mdx
  • docs/guides/new-build-system-preview.mdx
  • docs/how-it-works.mdx
  • docs/management/projects/runs.mdx
  • docs/runs/bulk-actions.mdx
  • docs/upgrading-beta.mdx
💤 Files with no reviewable changes (3)
  • docs/management/projects/runs.mdx
  • docs/guides/new-build-system-preview.mdx
  • docs/upgrading-beta.mdx
📜 Recent review details
⏰ Context from checks skipped due to timeout. (2)
  • GitHub Check: Analyze (javascript-typescript)
  • GitHub Check: code-quality / code-quality
🧰 Additional context used
📓 Path-based instructions (2)
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

Documentation in docs/ uses MDX conventions defined by the documentation guidance.

Files:

  • docs/guides/examples/puppeteer.mdx
  • docs/guides/examples/lightpanda.mdx
  • docs/config/extensions/lightpanda.mdx
  • docs/runs/bulk-actions.mdx
  • docs/bulk-actions.mdx
  • docs/ai-chat/changelog.mdx
  • docs/ai-chat/how-it-works.mdx
  • docs/how-it-works.mdx
  • docs/config/extensions/puppeteer.mdx
docs/**/docs.json

📄 CodeRabbit inference engine (docs/CLAUDE.md)

docs/**/docs.json: Main documentation config must be defined in docs.json which includes navigation structure, theme, and metadata
Navigation structure in docs.json should be organized using navigation.dropdowns with groups and pages

Files:

  • docs/docs.json
🧠 Learnings (4)
📚 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/guides/examples/puppeteer.mdx
  • docs/guides/examples/lightpanda.mdx
  • docs/config/extensions/lightpanda.mdx
  • docs/runs/bulk-actions.mdx
  • docs/bulk-actions.mdx
  • docs/ai-chat/changelog.mdx
  • docs/ai-chat/how-it-works.mdx
  • docs/how-it-works.mdx
  • docs/config/extensions/puppeteer.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/guides/examples/puppeteer.mdx
  • docs/guides/examples/lightpanda.mdx
  • docs/config/extensions/lightpanda.mdx
  • docs/runs/bulk-actions.mdx
  • docs/bulk-actions.mdx
  • docs/ai-chat/changelog.mdx
  • docs/ai-chat/how-it-works.mdx
  • docs/how-it-works.mdx
  • docs/config/extensions/puppeteer.mdx
📚 Learning: 2026-06-16T13:14:09.440Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3964
File: docs/ai-chat/reference.mdx:482-482
Timestamp: 2026-06-16T13:14:09.440Z
Learning: When documenting or reviewing usage of `ChatTurn.complete(source?)` (in `packages/trigger-sdk/src/v3/ai.ts`), note that `source` is optional (`source?: UIMessageStreamable`). Calling `complete()` with no `source` is valid specifically for a final head-start handover (`handover.isFinal`), because the warm partial already contains the response. If examples or guidance omit `source`, ensure they are in this final-hand-over context so they remain correct.

Applied to files:

  • docs/ai-chat/changelog.mdx
  • docs/ai-chat/how-it-works.mdx
📚 Learning: 2026-06-16T13:14:14.382Z
Learnt from: ericallam
Repo: triggerdotdev/trigger.dev PR: 3964
File: docs/ai-chat/reference.mdx:478-478
Timestamp: 2026-06-16T13:14:14.382Z
Learning: When reviewing RC-gated `ai-chat` docs under `docs/ai-chat/`, don’t immediately flag missing SDK type fields or implementation details just because the field isn’t present on the docs branch yet. Instead, find and cross-check the companion implementation PR that’s intended to land alongside the docs PR, and only report missing/incorrect fields if they are also absent in the companion SDK/type changes.

Applied to files:

  • docs/ai-chat/changelog.mdx
  • docs/ai-chat/how-it-works.mdx
🔇 Additional comments (10)
docs/ai-chat/changelog.mdx (1)

2-2: LGTM!

docs/ai-chat/how-it-works.mdx (1)

2-2: LGTM!

docs/bulk-actions.mdx (1)

2-3: LGTM!

docs/config/extensions/lightpanda.mdx (1)

2-2: LGTM!

docs/config/extensions/puppeteer.mdx (1)

2-2: LGTM!

docs/guides/examples/lightpanda.mdx (1)

2-2: LGTM!

docs/guides/examples/puppeteer.mdx (1)

2-2: LGTM!

docs/how-it-works.mdx (1)

2-2: LGTM!

docs/runs/bulk-actions.mdx (1)

2-3: LGTM!

docs/docs.json (1)

724-738: LGTM!


Walkthrough

Updated documentation frontmatter titles and sidebar labels for AI Agents SDK, build extension, example, dashboard, and SDK pages. Added permanent redirects for extension and upgrade documentation paths. Removed the beta upgrade, new build system preview, and project runs documentation pages.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description only has a summary and omits the template's issue link, checklist, testing, changelog, and screenshots sections. Add the required template sections: issue reference, checklist, testing steps, changelog summary, and screenshots or note that none are needed.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the unique title tags and redirect changes.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch seo-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.

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@D-K-P
D-K-P enabled auto-merge (squash) July 29, 2026 11:08
@D-K-P
D-K-P merged commit 8d321f8 into main Jul 29, 2026
22 checks passed
@D-K-P
D-K-P deleted the seo-fixes branch July 29, 2026 11:09
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