Skip to content

docs(langsmith): document watching issues in Engine#4768

Draft
bentanny wants to merge 6 commits into
mainfrom
tannyhill/engine-watch-docs
Draft

docs(langsmith): document watching issues in Engine#4768
bentanny wants to merge 6 commits into
mainfrom
tannyhill/engine-watch-docs

Conversation

@bentanny

@bentanny bentanny commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds a Watch an issue section to engine.mdx covering: the Watch toggle, the "Alert me via Slack" shortcut (deep-links to Notifications settings), and the alert banner shown when new traces link to a watched issue.
  • Updates Open a pull request to mention the PR number/branch now shown in the Fix workflow's first step, and the toolbar Fix button reflecting PR status.
  • Updates Resolve or ignore an issue to mention the Mark as Resolved / Discard Fix shortcuts available inside the Fix workflow.
  • Updates Reopen an issue to note that reopening clears any in-progress fix and watch state.

Context

Based on frontend work in langchain-ai/langchainplus#28777 (issue board detail panel redesign — Watch/Fix panel UX, PR-aware Fix step, alert banner). That PR is not yet merged to main — this docs PR is drafted in parallel per request; hold until #28777 lands (or confirm behavior is final) before merging.

Test plan

  • Verify wording against final shipped behavior once langchainplus#28777 merges
  • make lint_md / make broken-links (not run locally — markdownlint not installed in this environment)

Adds a "Watch an issue" section covering the Watch toggle, the
Slack-alert shortcut, and the new-traces alert banner. Also updates
the Fix workflow docs to mention the PR link/branch shown in step one
and the Mark as Resolved / Discard Fix shortcuts.
@github-actions github-actions Bot added langsmith For docs changes to LangSmith internal labels Jul 7, 2026
bentanny added 5 commits July 7, 2026 12:32
The previous pass kept old flat action descriptions (a standalone
"Resolve" button, "Open a pull request" as its own top-level action)
that no longer match the redesigned toolbar. Reorganize "Take action
on an issue" around the three actual toolbar buttons — Fix, Watch,
Close — with Open PR / Add offline examples / Create an evaluator
folded in as the three steps of the Fix panel, and Resolve/Ignore/
Reopen folded into the Close menu. Anchor text for cross-referenced
headings (Open a pull request, Add offline examples, Create an
evaluator) is unchanged so existing links elsewhere still resolve.
- Shorten the "Take action on an issue" intro to a single line
- Drop the regression-monitor/Create an evaluator step from Fix and
  the top CardGroup — evaluator creation isn't unique to Fix
- Remove the Suggested Evaluator paragraph from Review an issue
Reframe each action around what it accomplishes (ship and test a fix,
monitor without closing, record an outcome) instead of narrating the
click path (open this panel, click this button to open that dialog).
@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Mintlify preview branch generated: preview-tannyh-1783459326-edf94ac

Site preview: https://langchain-5e9cc07a-preview-tannyh-1783459326-edf94ac.mintlify.app

Important

Preview links may take a few minutes to start working while the deployment finishes.

Changed documentation pages (preview deep links):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal langsmith For docs changes to LangSmith

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant