Add Advanced Guides to zBench Documentation

[hendriknielaender]

Issue Description

Currently, the zBench documentation provides coverage of basic usage. However, there's a need for more advanced guides that delve deeper into the library's capabilities, particularly for users who are ready to explore complex benchmarking scenarios.

Need for Advanced Guides

Advanced users of zBench could greatly benefit from guides that explore:

• Custom Metrics implementation.
• Benchmarking concurrent or asynchronous code.
• In-depth analysis of benchmarking results.
• Integrating zBench with CI/CD pipelines.

These topics are essential for users who wish to leverage the full potential of zBench in more complex environments.

Proposed Advanced Guides

1. Custom Metrics Guide: A detailed walkthrough on how to implement and use custom metrics in zBench.
2. Concurrent Benchmarking Guide: Instructions and examples on how to benchmark concurrent or asynchronous code.
3. Result Analysis Guide: Techniques and tips for performing an in-depth analysis of benchmarking results.
4. CI/CD Integration Guide: A guide on integrating zBench into CI/CD pipelines to automate performance testing.

Action Items

• Write the "Custom Metrics Guide" for advanced metric tracking.
• Develop the "Concurrent Benchmarking Guide" with practical examples.
• Create the "Result Analysis Guide" focusing on interpreting and utilizing benchmark results.
• Prepare the "CI/CD Integration Guide" for setting up zBench in CI/CD workflows.
• Review and integrate these guides into the existing zBench documentation structure.

Expected Outcome

The addition of these advanced guides will not only enrich our documentation but also empower our users to use zBench more effectively in complex scenarios. It will bridge the gap between intermediate and advanced usage, making zBench a more versatile tool for performance analysis.

Additional Notes

Any contributions, suggestions, or discussions regarding the content and structure of these guides are highly welcome. Collaboration on this task is key to ensuring that the guides are comprehensive and beneficial to our user base.

[FObersteiner]

Not exactly an advanced guide but speaking of docs (not worth an extra issue IMHO) - currently, the "Install Options" take up a lot of space in the main readme.

• we might want to move that to a separate .md file and link to it in the main readme
• we should add a note on using zig fetch [url-to-package-.tar.gz] --save, which is quite convenient for setting the hash in the .zon file and also updating an existing dependency

[hendriknielaender]

Good point! I will quickly create a PR for it 👍