Skip to content

docs: lead with agents, refresh screenshots and drop dated pages - #5137

Closed
jackbridger wants to merge 3 commits into
mainfrom
docs/refresh-positioning-and-nav
Closed

jackbridger wants to merge 3 commits into
mainfrom
docs/refresh-positioning-and-nav

Conversation

@jackbridger

Copy link
Copy Markdown
Collaborator

Summary

Makes the docs lead with what Trigger.dev is today (durable AI agents and workflows) and removes things that make them look out of date.

Positioning and navigation:

  • The site description (also the summary line of llms.txt), the quick start description and the Realtime page descriptions now use the introduction's positioning instead of "background jobs".
  • Agents moves up to sit right after Getting started, and the AI agent guides get their own group near the top of Guides & examples. Next.js leads the Frameworks list.
  • Hidden from the sidebar (URLs still work): the 2024 video walkthrough, the Mergent migration (Mergent shut down in July 2025), the AI chat changelog (it stopped at 4.5.0 and now points to the main changelog), and example projects built on models that have been shut down (Claude 3.7 thinking chatbot, the DALL·E meme generator, the AI SDK image generator and the DALL·E 3 example task). The v3 migration guide stays searchable for self-hosters but leaves the sidebar.

Coding agents:

  • The front page and Building with AI now list Claude Code, Codex, Cursor and other current coding agents, and the context-file table leads with AGENTS.md.
  • MCP client tabs are reordered by current usage, Windsurf is removed, Devin Desktop gets its own tab with its current config path, and Amp is no longer labelled as part of Sourcegraph.

Screenshots:

  • Fifteen screenshots from 2024 (old dashboard layout, a v3 beta CLI) are replaced with captures of the current dashboard and CLI: the quick start run page and terminal output, run log, environment variables, replaying, tags and alerts. They were taken in a demo org with placeholder data.

Also: the Docker self-hosting page drops its v4 launch framing but keeps the list of what the setup includes, and a few sample strings no longer call the product a background jobs platform.

mintlify broken-links reports no broken links.

Use the introduction's positioning in the site description, quick
start and Realtime pages instead of "background jobs". Move Agents
right after Getting started and give the AI agent guides their own
group. Hide the video walkthrough, the Mergent migration, the old AI
chat changelog and example projects that call shut-down models, and
keep the v3 migration searchable but out of the sidebar. Update the
coding agent lists and MCP client tabs, lead the context-file table
with AGENTS.md, and drop the v4 launch framing on the Docker page.
Replace screenshots from 2024 (old dashboard layout and a v3 beta CLI)
with captures of the current dashboard and CLI for the run page, run
log, environment variables, replaying, tags and alerts pages, and fix
the replay image alt text.
@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The documentation updates MCP client instructions and AI coding tool guidance. The navigation changes group placement and example listings, and several pages are marked hidden. Other edits update product terminology, example descriptions, Docker feature text, and replay screenshots.

Merge Risk: Minimal · up to cc26c

This PR refreshes the documentation to lead with AI agents, updates screenshots, and hides dated pages. The earlier formatting problem in docs.json appears to be fixed in the latest commit, and no other merge-blocking issues were found. The formatter could not be run independently, so CI should confirm the format check passes.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title "docs: lead with agents, refresh screenshots and drop dated pages" matches the main changes. The raw summary and PR objectives show repositioning toward durable AI agents and workflows, navi…
Description check Passed The description follows the template's overall structure. It has a Summary section explaining the changes. It reports that broken-link checks passed. It does not include the template's Closes #…
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.
Full details: Title check

Explanation

The title "docs: lead with agents, refresh screenshots and drop dated pages" matches the main changes. The raw summary and PR objectives show repositioning toward durable AI agents and workflows, navigation reordering, hidden dated pages, and replaced screenshots. It follows the conventional "docs:" prefix. It is slightly long at 64 characters, but it is specific and clear.

Full details: Description check

Explanation

The description follows the template's overall structure. It has a Summary section explaining the changes. It reports that broken-link checks passed. It does not include the template's Closes #<issue> line, the checklist, a Testing section with steps, or a Changelog section. Screenshots are described in text but not attached. The description covers the substance of the PR, so the gaps are mostly in template sections.

Resolution

Consider adding the missing template items for completeness: a "Closes #<issue>" line if an issue exists, the checklist items, a Testing section describing how the docs were checked (for example, a local Mintlify preview), and a Changelog entry. Attaching a few of the replaced screenshots under Screenshots would also help reviewers.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Repository UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 72a1ec8e-6115-4093-ad93-6b1b320d2957
Commits

Reviewing files that changed from the base of the PR and between 2c534b2 and cc26c57.

Files selected for processing: 1

  • docs/docs.json
Files skipped from review as they are similar to previous changes: 1

  • docs/docs.json

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 5 remain after this review.

Recent review details

Context from checks skipped due to timeout: 3

  • GitHub Check: code-quality / code-quality
  • GitHub Check: Analyze (actions)
  • GitHub Check: Analyze (javascript-typescript)

@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.

Devin Review

coderabbitai[bot]

This comment was marked as resolved.

@changeset-bot

changeset-bot Bot commented Nov 17, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: cc26c57

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

@jackbridger
jackbridger deleted the docs/refresh-positioning-and-nav branch November 17, 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.

1 participant