Skip to content

Add plain English description of exported data to History Export docs#4234

Open
dustin-temporal wants to merge 2 commits intomainfrom
docs/export-data-description
Open

Add plain English description of exported data to History Export docs#4234
dustin-temporal wants to merge 2 commits intomainfrom
docs/export-data-description

Conversation

@dustin-temporal
Copy link
Contributor

@dustin-temporal dustin-temporal commented Feb 24, 2026

Summary

  • Adds a new "What's in the exported data" section to the Workflow History Export page
  • Plain English bullet list describing what events capture (workflow config, activity lifecycle, timers, signals, child workflows, results)
  • Notes that search attributes use user-defined names, not internal column names
  • JSON example showing a minimal deserialized workflow (start → activity → complete) so users can see the structure without reading the proto schema

Why

Customers using History Export were confused because the docs only linked to a proto schema with no description of what's actually in the files.

Checklist

  • Follows STYLE.md guidelines (proper noun capitalization, sentence case headings)
  • Frontmatter unchanged (existing page edit)
  • Links to proto schema maintained
  • No sidebars.js changes needed (existing page)
  • Valid JSON in code block (no comments)

┆Attachments: EDU-5941 Add plain English description of exported data to History Export docs

Addresses customer confusion where the docs only linked to a proto schema
with no description of what's actually in the export files.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@dustin-temporal dustin-temporal requested a review from a team as a code owner February 24, 2026 17:35
@vercel
Copy link

vercel bot commented Feb 24, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
temporal-documentation Ready Ready Preview, Comment Feb 24, 2026 5:47pm

Request Review

@github-actions
Copy link
Contributor

github-actions bot commented Feb 24, 2026

📖 Docs PR preview links

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