Skip to content

Artifact Viewer

The Artifact Viewer displays design documents, requirements, and other artifacts generated during rp1 workflows. Access it from run details or the project artifacts list.

Accessing Artifacts

From Run Details

  1. Navigate to a run in the dashboard
  2. Click any artifact in the Artifacts panel
  3. The artifact opens in the viewer

Direct URL

/runs/:runId/artifacts/:artifactPath

Where :artifactPath is the relative path to the artifact (e.g., requirements.md).

Layout

The Artifact Viewer uses a multi-panel layout:

Panel Position Description
Navigation Left (collapsible) File tree and artifact list
Content Center Rendered artifact content
Outline Right (collapsible) Table of contents / heading navigation
Annotations Right (collapsible) Annotation sidebar (when enabled)

Toggle panels using the toolbar buttons or keyboard shortcuts.

Supported Content Types

Extension Rendering
.md Markdown with syntax highlighting, Mermaid diagrams
.json Formatted JSON with collapsible sections
.mmd Mermaid diagram rendering
.diff Unified diff with syntax highlighting
Code files Syntax-highlighted code with line numbers

Markdown Features

Syntax Highlighting

Code blocks render with language-specific syntax highlighting. Supported languages include JavaScript, TypeScript, Python, Go, Rust, and more.

Mermaid Diagrams

Mermaid code blocks render as interactive diagrams:

graph LR
    A[Start] --> B[End]

Table of Contents

The outline panel shows document headings for quick navigation. Click a heading to scroll to that section.

Annotations

The annotation system enables inline feedback on artifacts. See Annotations for complete documentation.

Quick Reference

Action How
Add comment Select text, click "Add Comment" in the popover
View annotations Toggle annotation sidebar with toolbar button
Reply to annotation Click annotation, enter reply, Cmd/Ctrl + Enter
Resolve annotation Click annotation, click Resolve button

Annotation Sidebar

The sidebar displays all annotations for the current artifact, grouped by status:

  • Open: Active feedback requiring attention (yellow indicator)
  • Resolved: Addressed annotations (green indicator, collapsed)
  • Orphaned: Annotations with missing anchors (warning badge)

Click a sidebar item to scroll to the annotation and open its popover. Long comments are truncated with a "Show more" option.

Inline Indicators

Annotations display as thin vertical lines on the left side of annotated content:

  • Yellow line: Open annotation requiring attention
  • Green line: Resolved annotation
  • Click the indicator to open the annotation popover

Keyboard Shortcuts

Shortcut Action
Cmd/Ctrl + B Toggle navigation sidebar
Cmd/Ctrl + Enter Submit annotation (when input focused)
Escape Close popover