sys-intelligence / sys-intelligence/system-intelligence-benchmark

Add a `WHY.md` File for Each Benchmark

Open
#22 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement good first issue
Dominant language
TLA
Stars
55
Forks
13
PR merge metrics
No merged PRs in 30d

Description

Currently, the root-level README lists all benchmarks with a brief one-liner description. Each benchmark’s folder contains a large README where the motivation and rationale are buried within the details.

We should create a dedicated WHY.md file inside each benchmark’s folder. This file should explain:

  • Why the benchmark matters
  • How it fits into our broader vision of system intelligence

See #21 for a similar file

We should then link each WHY.md file from the corresponding bullet point in the root README.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the root-level README, each benchmark folder’s README, and issue #21 for the intended WHY.md structure. Create a WHY.md in every benchmark folder covering its motivation and role in system intelligence, then link each file from the corresponding root README bullet.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.