search

probe-lab / website

https://probelab.io
2 stars 6 forks source link

Weekly report numbering format is confusing #97

Closed mishmosh closed 7 months ago

mishmosh commented 7 months ago

Under Ethereum > discv5 weekly reports, I see 2 reports labelled:

Is this the report from [MONTH]-9th day, or the 9th report of 2024?

guillaumemichel commented 7 months ago

These are the reports of the 2nd and 9th week of 2024. Reports are generated on a weekly basis.

We are still finalizing the template, and only have 2 placeholder reports for now, but hopefully it will make more sense once the report numbers increase linearly.

yiannisbot commented 7 months ago

Thanks for the feedback @mishmosh! We discussed it before and will fix to make it clearer. @guillaumemichel I'll add an explanation on the formatting at the top of the Methodology page. I reckon we should also add a note at the top of each report (or the title?) to make it clearer there too. Where can I find the template where each report is generated?

mishmosh commented 7 months ago

Thanks, I do think some simple wording tweaks will help a lot.

yiannisbot commented 7 months ago

We've added wording upfront both in the Methodology page (https://github.com/probe-lab/website/pull/100): https://probelab.io/ethereum/discv5/methodology/ and also at the top of every weekly report.

Thanks again for the feedback @mishmosh. Closing the issue and let's revisit when we have a few more reports to see how things look and if anything needs changing. If you have ideas, re-open, or start a new one.