docs: add reports output formats documentation page#96
Merged
himanshu231204 merged 1 commit intoJul 14, 2026
Merged
Conversation
Contributor
|
Hey @PrinceThummar011! 👋 Welcome to OpenAgent Eval, and thank you so much for this fantastic first contribution! This is a really well-crafted documentation page — I love the attention to detail:
I've verified that: Really impressed with how thorough this is for a first PR. This closes #95 perfectly. Looking forward to more contributions from you! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new documentation page (
docs/reports.md) that explains all 5 reportoutput formats produced by OpenAgent Eval: Terminal, Markdown, HTML, JSON,
and Comparison. Previously these formats were only discoverable by reading
source code — this page gives users a single reference for what each format
looks like, how to generate it, and when to use it.
Closes #95
What's included
For each of the 5 formats:
Formats covered:
oaeval report).mdfile with tables (--output markdown)--output html), includingtemplate customization
--output json)oaeval compare)Other changes
docs/reports.mdinmkdocs.ymlnavigationdocs/index.md(Beautiful Reports feature card)Testing
oaeval report/oaeval compareruns (or
tests/unit/test_reports/fixtures where a live run wasn'tfeasible)
mkdocs serveto confirm nav and rendering