docs: Improve documentation to contribute benchmarks for beginner and advanced ado users
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Domain
- documentation
Research direction
Start with docs/contributing/add_benchmark.md, especially the linked lines 164-192, and compare its commands with the ADO documentation and Random Walk example. Verify that the documented commands terminate successfully; done means the page supports experienced users with a concise link and, if retained, includes a self-contained benchmark example that works from start to finish.
Written by the indexing model from the issue text.
Description
Different readers will approach the documentation with varying requirements and levels of familiarity with ADO. This makes it difficult to provide a single set of ADO commands that suits every use case. Below are two common scenarios and possible approaches:
Case 1 - Readers already familiar with ADO: These users are typically capable of configuring and validating their own benchmarks. For this audience, a brief reminder together with a link to the ADO documentation should be sufficient.
Case 2 - Readers with no prior ADO experience: For users new to both Nexus and ADO:
- The project already provides examples that can serve as a starting point (for example, the Random Walk example: https://ibm.github.io/ado/examples/random-walk/).
- If an example is added to the Nexus project, it should be fully self-contained and executable from start to finish, allowing users to reproduce the workflow
Done when:
- the page describes only commands that terminate with success
- (optional) If deemed necessary, the documentation provides a working example of how to create a benchmark where all commands work start to finish. This could reuse example from from ado if suitable
- Dominant language
- Python
- Stars
- 3
- Forks
- 7
- Avg merge
- 8h 46m
- Merged PRs (30d)
- 13
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.
More from IBM/algorithm-nexus
-
security
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
IBM/algorithm-nexus#247 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
IBM/algorithm-nexus#213 · 2 comments ·
-
IBM/algorithm-nexus#240 · 1 assignee ·
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 35/100
IBM/algorithm-nexus#149 ·
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 35/100
IBM/algorithm-nexus#109 ·
All issues in IBM/algorithm-nexus
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100