Skip to content

chore: add docs on custom output rendering #1208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 11 commits into from
Oct 31, 2025
Merged

chore: add docs on custom output rendering #1208

merged 11 commits into from
Oct 31, 2025

Conversation

@ayoung19
Copy link
Contributor

@ayoung19 ayoung19 commented Oct 31, 2025 •
edited
Loading

Overview

adds documentation on custom output rendering

Type of change

Type: New documentation page

Related issues/PRs

  • GitHub issue:
  • Feature PR:
  • Linear issue: LS-5480
  • Slack thread:

Checklist

  • I have read the contributing guidelines
  • I have tested my changes locally using docs dev
  • All code examples have been tested and work correctly
  • I have used root relative paths for internal links
  • I have updated navigation in src/docs.json if needed
  • I have gotten approval from the relevant reviewers
  • (Internal team members only / optional) I have created a preview deployment using the Create Preview Branch workflow

Additional notes

@ayoung19 ayoung19 requested a review from katmayb as a code owner October 31, 2025 00:15
Copilot AI review requested due to automatic review settings October 31, 2025 00:15
@ayoung19 ayoung19 requested a review from lnhsingh as a code owner October 31, 2025 00:15
@github-actions github-actions bot added the langsmith For docs changes to LangSmith label Oct 31, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

Mintlify preview ID generated: preview-LS5480-1761869773-7018df5

Copilot AI reviewed Oct 31, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds comprehensive documentation for the custom output rendering feature in LangSmith. This feature allows users to visualize experiment outputs using custom HTML pages instead of the default JSON format.

Key changes:

  • New documentation page explaining custom output rendering with prerequisites, configuration steps, and implementation examples
  • Integration of the new page into the navigation structure under the Datasets section in the Evaluation tab

Reviewed Changes

Copilot reviewed 2 out of 7 changed files in this pull request and generated no comments.

File Description
src/langsmith/custom-output-rendering.mdx Adds complete documentation for custom output rendering, including UI and API configuration methods, message format specification, example implementation, and usage context
src/docs.json Adds the new custom-output-rendering page to the Datasets section navigation

katmayb
katmayb approved these changes Oct 31, 2025
View reviewed changes
Copy link
Contributor

@katmayb katmayb left a comment

Choose a reason for hiding this comment

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

lgtm, couple of suggestions/nits for you to consider. Thanks!

src/langsmith/custom-output-rendering.mdx Outdated

### Example implementation

Here's a minimal example that displays all received messages:
Copy link
Contributor

@katmayb katmayb Oct 31, 2025

Choose a reason for hiding this comment

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

Just a suggestion, but is there anything you want to explain / describe in the example?

Copy link
Contributor Author

@ayoung19 ayoung19 Oct 31, 2025

Choose a reason for hiding this comment

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

Yes! Nice catch.

@ayoung19 @katmayb
Update src/langsmith/custom-output-rendering.mdx
3a3fdcc 
Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
Copilot AI review requested due to automatic review settings October 31, 2025 16:38
@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

Mintlify preview ID generated: preview-LS5480-1761928762-7dab837

Copilot AI reviewed Oct 31, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 2 out of 7 changed files in this pull request and generated 2 comments.

@ayoung19 @katmayb
Update src/langsmith/custom-output-rendering.mdx
96d8c54 
Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
Copilot AI review requested due to automatic review settings October 31, 2025 16:41
ayoung19 and others added 7 commits October 31, 2025 09:41
@ayoung19 @katmayb
Update src/langsmith/custom-output-rendering.mdx
fccdc15 
Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
@ayoung19 @katmayb
Update src/langsmith/custom-output-rendering.mdx
9f33ced 
Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
@ayoung19 @katmayb
Update src/langsmith/custom-output-rendering.mdx
9e37de1 
Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
@ayoung19 @katmayb
Update src/langsmith/custom-output-rendering.mdx
5b53e5a 
Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
@ayoung19 @katmayb
Update src/langsmith/custom-output-rendering.mdx
b01f165 
Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
@ayoung19 @katmayb
Update src/langsmith/custom-output-rendering.mdx
7907dbf 
Co-authored-by: Kathryn May <44557882+katmayb@users.noreply.github.com>
@ayoung19
Revert "Update src/langsmith/custom-output-rendering.mdx"
abb31da 
This reverts commit 3a3fdcc.
@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

Mintlify preview ID generated: preview-LS5480-1761928994-c66f12d

Copilot AI reviewed Oct 31, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 2 out of 7 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

src/langsmith/custom-output-rendering.mdx:1

  • The step numbering is inconsistent. Step 4 mentions "Toggle ... to on" and step 5 says "Enter the webpage URL", but the modal image shows these are likely part of the same action or the URL field appears when toggling is enabled. Consider revising to clarify the sequential relationship or combine these steps if they occur simultaneously.
---

@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

Mintlify preview ID generated: preview-LS5480-1761929086-25db1ae

@github-actions
Copy link
Contributor

github-actions bot commented Oct 31, 2025

Mintlify preview ID generated: preview-LS5480-1761929937-b1c0f6b

@ayoung19 ayoung19 merged commit 34b9e3f into main Oct 31, 2025
11 checks passed
@ayoung19 ayoung19 deleted the LS-5480 branch October 31, 2025 17:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@katmayb katmayb katmayb approved these changes

@lnhsingh lnhsingh Awaiting requested review from lnhsingh lnhsingh is a code owner

Assignees

No one assigned

Labels

langsmith For docs changes to LangSmith

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ayoung19 @katmayb