Skip to content

[WIP] Benchpark New Developer Docs #786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

amroakmal
Copy link
Collaborator

Based on what I learned and my understanding so far, this issue tracks new insights into Benchpark (BP) to deepen understanding of its execution flow. It also serves as developer documentation by offering more detailed information than the main docs.

Fixes: #785

Summary for what's introduced:

  1. Introduce Developer Documentation that are more in depth than default docs, for discussing some important Benchpark concepts (e.g. variants, modifiers)
  2. Deeper details for what core BP commands make upon execution
  3. Easy steps for debugging BP with VSCode providing the launch configurations
  4. Easier installation for dependencies needed for building the docs/ to be able to check locally

@amroakmal amroakmal self-assigned this May 23, 2025
@amroakmal amroakmal added docs Improvements or additions to documentation WIP A work-in-progress not yet ready to commit labels May 23, 2025
@amroakmal amroakmal changed the title [WIP] Benchpark New Developer Docs Benchpark New Developer Docs May 23, 2025
@amroakmal amroakmal removed the WIP A work-in-progress not yet ready to commit label May 23, 2025
@amroakmal amroakmal force-pushed the 785-benchpark-analysis branch 11 times, most recently from d079933 to a91094b Compare May 23, 2025 23:06
Copy link
Collaborator

@pearce8 pearce8 left a comment

Choose a reason for hiding this comment

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

Please fix the spelling which makes docs build fail.

@amroakmal amroakmal requested a review from pearce8 May 26, 2025 02:38
@amroakmal
Copy link
Collaborator Author

amroakmal commented May 26, 2025

Please fix the spelling which makes docs build fail.

@pearce8 : Done, Dr. Olga, and rebased too.

@amroakmal amroakmal force-pushed the 785-benchpark-analysis branch from 39b7b55 to eb6aac3 Compare May 26, 2025 03:10
@amroakmal amroakmal added the WIP A work-in-progress not yet ready to commit label May 27, 2025
@amroakmal amroakmal changed the title Benchpark New Developer Docs [WIP] Benchpark New Developer Docs May 27, 2025
Copy link
Collaborator

@michaelmckinsey1 michaelmckinsey1 left a comment

Choose a reason for hiding this comment

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

Some content review and suggestions

:maxdepth: 1
:caption: Developer Docs

developer-docs/benchpark-developer-docs.rst
Copy link
Collaborator

Choose a reason for hiding this comment

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

I would advise to split

* `Core Concepts and Patterns`_ - Understanding Variants, Consistent Flow, and Modifiers
* `Benchpark Command Workflow`_ - Step-by-step execution of key Benchpark commands  
* `Debugging Benchpark with VSCode`_ - Setting up debugging environment for development

these into 3 pages here instead of 1 single page.

@slabasan slabasan mentioned this pull request Jul 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation WIP A work-in-progress not yet ready to commit
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Benchpark Execution Deeper Analysis
3 participants