Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Measurement and Scoring details to about page #467

Merged
merged 12 commits into from
Jan 8, 2025

Conversation

camillobruni
Copy link
Contributor

Given that this comes up ever so often in discussion with internal and external folks it might be worthwhile documenting in a bit more detail which parts are measured and how we calculate the final score.

  • Add example timeline to explain which parts contribute to the score
  • Add basic formulas on how the test steps are combined into a final score

@camillobruni
Copy link
Contributor Author

After fixing the paragraphs this is ready for reviews.

Screenshot 2025-01-06 at 15 38 02 Screenshot 2025-01-06 at 15 38 12

@bgrins
Copy link
Contributor

bgrins commented Jan 6, 2025

Instead of the about page, could we put this type of information in a markdown file in the repo? That way it wouldn't require publishes to browserbench.org (presumably requiring a version bump) to update the content.

@camillobruni
Copy link
Contributor Author

I can put it into a separate html file, markdown is likely the wrong file format for math formulas and tables, no?

@bgrins
Copy link
Contributor

bgrins commented Jan 6, 2025

I think you can embed the HTML into markdown to preserve the ability to host the preview directly out of the github repo but no strong opinion either way.

@rniwa rniwa added trivial change A change that doesn't affect benchmark results documentation Improvements or additions to documentation labels Jan 7, 2025
@camillobruni
Copy link
Contributor Author

I've not pulled out the timeline table and the scoring math into separate SVGs (this seems to be the least brittle way to get externally formatted content into markdown).

WDYT?

@bgrins bgrins self-requested a review January 7, 2025 18:55
Copy link
Contributor

@bgrins bgrins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. We can iterate on it in the future as necessary

@camillobruni camillobruni merged commit 4dfa8fa into WebKit:main Jan 8, 2025
4 checks passed
@camillobruni camillobruni deleted the 2024-12-23_scoring branch January 8, 2025 10:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation trivial change A change that doesn't affect benchmark results
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants