Skip to content

Conversation

@yogesh1801
Copy link
Collaborator

Description

This PR addresses Issue #22 by adding dedicated WHY.md files to each benchmark directory and linking them from the root README. These files explain why each benchmark matters and how it fits into the broader vision of system intelligence, following the pattern established in PR #21.

Changes

  • Added WHY.md to System Exam Benchmark
  • Added WHY.md to System Lab Benchmark
  • Added WHY.md to System Artifact Benchmark
  • Added WHY.md to System Modeling Benchmark
  • Added WHY.md to Cache Algorithm Benchmark
  • Updated root README.md to add WHY links next to each benchmark entry in the benchmark list
  • Added Cache Algorithm Benchmark to the root README benchmark list (was previously missing)

Testing

  • Verified all 5 WHY.md files exist in their respective benchmark directories
  • Confirmed all WHY.md links in root README.md point to correct file paths
  • Reviewed each WHY.md for consistency with benchmark READMEs and overall system intelligence vision
  • Validated markdown formatting renders correctly

Checklist

  • Tests pass locally (documentation-only changes)
  • Code follows project style guidelines
  • Documentation updated (this PR is documentation enhancement)

@bastoica bastoica self-requested a review December 6, 2025 21:25
Copy link
Collaborator

@bastoica bastoica left a comment

Choose a reason for hiding this comment

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

I'm a bit confused as why you added a new WHY.md for arteval_bench. Is this simply the existing file or did you make any edits? Thanks!

@yogesh1801
Copy link
Collaborator Author

yogesh1801 commented Dec 6, 2025

Hi @bastoica sorry for the confusion the arteval benchmark file is same, it is error from my side that it looks like a new file in commit, but it is the same
I have fixed the issue in the next commit

Signed-off-by: Yogesh <yogeshsingla481@gmail.com>
@bastoica bastoica self-assigned this Dec 6, 2025
@bastoica bastoica requested a review from xuafeng December 6, 2025 23:00
@bastoica
Copy link
Collaborator

bastoica commented Dec 6, 2025

sounds good, thanks @yogesh1801

@xuafeng
Copy link
Collaborator

xuafeng commented Dec 11, 2025

@tareknaser can you help review if the new WHY.md make sense to you?

@xuafeng
Copy link
Collaborator

xuafeng commented Dec 11, 2025

@Qian-Cheng-nju can you help review if the new WHY.md of SysMoBench works for you? Welcome any comments.

Updated the number of systems and their types in the benchmark description.
@Qian-Cheng-nju
Copy link
Collaborator

@Qian-Cheng-nju can you help review if the new WHY.md of SysMoBench works for you? Welcome any comments.

We recently added the ringbuffer module from Asterinas and ZooKeeper, so I updated the description of the number and types of systems. Everything looks good to me now. Thank you very much for such a detailed document!

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.

4 participants