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

docs: Add test reporting doc to benchmarks dir #3238

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

stubbsta
Copy link

@stubbsta stubbsta commented Jan 14, 2025

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

  • Added file docs/benchmarks/test-results-summary.md

How to test

  1. Pull https://github.com/waku-org/docs.waku.org
  2. Edit url to use this branch: https://github.com/waku-org/docs.waku.org/blob/develop/fetch-content.js#L64
  3. yarn build
  4. yarn serve

@stubbsta stubbsta changed the title Add test reporting doc to benchmarks dir docs: Add test reporting doc to benchmarks dir Jan 14, 2025
@stubbsta
Copy link
Author

This is a draft to get inputs on the formatting and content.
The Quick ref section definitely needs work. I would appreciate some info on how to relate the data back to Status App.

Copy link
Contributor

@jm-clius jm-clius left a 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.

docs/benchmarks/test-results-summary.md Outdated Show resolved Hide resolved
docs/benchmarks/test-results-summary.md Outdated Show resolved Hide resolved
docs/benchmarks/test-results-summary.md Outdated Show resolved Hide resolved
docs/benchmarks/test-results-summary.md Outdated Show resolved Hide resolved
docs/benchmarks/test-results-summary.md Outdated Show resolved Hide resolved
docs/benchmarks/test-results-summary.md Outdated Show resolved Hide resolved
docs/benchmarks/test-results-summary.md Outdated Show resolved Hide resolved
docs/benchmarks/test-results-summary.md Outdated Show resolved Hide resolved
docs/benchmarks/test-results-summary.md Outdated Show resolved Hide resolved
docs/benchmarks/test-results-summary.md Show resolved Hide resolved
@stubbsta stubbsta force-pushed the add-performance-benchmarks-overview branch from 2362ed1 to e01a61e Compare January 20, 2025 06:00
@stubbsta
Copy link
Author

@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:

  • Relay network average bandwidth usage: x KB/s
  • Disv5 average bandwidth usage: y KB/s
  • etc.

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 Insights section and if they want even more info they can go look at the reports on notion?

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.

2 participants