-
Notifications
You must be signed in to change notification settings - Fork 56
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
docs: Add test reporting doc to benchmarks dir #3238
base: master
Are you sure you want to change the base?
Conversation
This is a draft to get inputs on the formatting and content. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this! I've added a couple of comments and suggestions on what other sections to add.
2362ed1
to
e01a61e
Compare
@fryorcraken I wonder if the TL;DR section is not too wordy? Is the requirement not to have it be something very short that can be read quickly and easily remembered such as:
and then if the reader wants more info (such as the network size and message rate for the simulations where the above values were obtained, they can look at the |
Description
This PR is a first pass at adding a nwaku test summary page which aims to provide a quick reference for anyone implementing the waku protocol using nwaku to see the expected performance as well as have quick access to test reports.
Changes
docs/benchmarks/test-results-summary.md
How to test