Harmonize readme structure of each benchmark
Open
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 51
- Forks
- 24
- PR merge metrics
- No merged PRs in 30d
Description
Our benchmark documentation could use a bit of improvement, and I think an initial thing to do would be to harmonize the readme document structure across the benchmarks. Then we can work on fleshing out content.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the README documents for each benchmark and comparing their current structures. Identify the sections that should be consistent across them, then update the benchmark READMEs so they follow a shared structure. Done means the README organization is harmonized across all benchmarks; the issue does not specify the target section layout.
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
- 35/100