-
Notifications
You must be signed in to change notification settings - Fork 33
[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
base: develop
Are you sure you want to change the base?
Conversation
d079933
to
a91094b
Compare
There was a problem hiding this 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.
@pearce8 : Done, Dr. Olga, and rebased too. |
39b7b55
to
eb6aac3
Compare
There was a problem hiding this 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 |
There was a problem hiding this comment.
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.
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: