Skip to content

docs(site): clarify splitReportFile output in consume-report-file docs#2409

Merged
yuyutaotao merged 1 commit intomainfrom
codex/update-documentation-for-splitreportfile-output
Apr 27, 2026
Merged

docs(site): clarify splitReportFile output in consume-report-file docs#2409
yuyutaotao merged 1 commit intomainfrom
codex/update-documentation-for-splitreportfile-output

Conversation

@yuyutaotao
Copy link
Copy Markdown
Collaborator

Motivation

  • Clarify the difference between splitReportFile and reportFileToMarkdown in the consume-report-file documentation so readers understand that splitReportFile produces raw ReportActionDump-style JSON per execution plus exported screenshots while reportFileToMarkdown produces human-readable Markdown and its referenced screenshots.

Description

  • Updated both English and Chinese apps/site/docs/*/consume-report-file.md to add an explicit explanation of the distinct outputs (*.execution.json + screenshots vs Markdown + screenshots) and recommend when to use each function.

Testing

  • Ran pnpm run lint (failed in this environment due to biome scanning large files under ./.pnpm-store and hitting the configured files.maxSize), and ran npx biome check apps/site/docs/en/consume-report-file.md apps/site/docs/zh/consume-report-file.md --diagnostic-level=info --no-errors-on-unmatched which succeeded.

Codex Task

@yuyutaotao yuyutaotao merged commit d7bec72 into main Apr 27, 2026
8 checks passed
@yuyutaotao yuyutaotao deleted the codex/update-documentation-for-splitreportfile-output branch April 27, 2026 08:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant