chore: add docs on configuring custom output rendering for annotation queues #1267
Conversation
|
Mintlify preview ID generated: preview-LS5491-1762249709-e1c3492 |
There was a problem hiding this comment.
Pull Request Overview
This PR updates the custom output rendering documentation to reflect a new feature: configuring custom rendering at the annotation queue level in addition to the dataset level. The documentation has been reorganized to improve clarity and flow, removing API configuration examples and streamlining the content.
Key changes:
- Added annotation queue-level custom rendering configuration alongside existing dataset-level configuration
- Reorganized content flow by removing the separate "Overview" section and integrating its content into the introduction
- Removed API configuration instructions (Python/TypeScript code examples) and "Prerequisites" section
|  | ||
|
|
||
| - **Annotation queues**: When experiments are added to annotation queues for review: | ||
| - **Annotation queues**: When reviewing runs in annotation queues: |
There was a problem hiding this comment.
[nitpick] Consider using a more specific verb. 'When reviewing runs' could be 'When you review runs' to maintain consistency with the second-person voice per the style guide.
| - **Annotation queues**: When reviewing runs in annotation queues: | |
| - **Annotation queues**: When you review runs in annotation queues: |
| Configure custom rendering at two levels: | ||
|
|
||
| - **For datasets**: Apply custom rendering to all runs associated with that dataset, wherever they appear—in experiments, run detail panes, or annotation queues. | ||
| - **For annotation queues**: Apply custom rendering to all runs within a specific annotation queue, regardless of which dataset they come from. This takes precedence over dataset-level configuration. |
There was a problem hiding this comment.
[nitpick] The precedence note appears twice (here and in the Info box at line 52-54). Consider removing the precedence mention from line 22 to avoid redundancy, keeping only the more prominent Info callout.
| - **For annotation queues**: Apply custom rendering to all runs within a specific annotation queue, regardless of which dataset they come from. This takes precedence over dataset-level configuration. | |
| - **For annotation queues**: Apply custom rendering to all runs within a specific annotation queue, regardless of which dataset they come from. |
Overview
Type of change
Type: Update existing documentation
Related issues/PRs
Checklist
docs devsrc/docs.jsonif neededAdditional notes