Skip to content
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

Wizard docs #2800

Open
ErikEJ opened this issue Jan 24, 2025 · 9 comments
Open

Wizard docs #2800

ErikEJ opened this issue Jan 24, 2025 · 9 comments
Labels
enhancement New feature or request reveng

Comments

@ErikEJ
Copy link
Owner

ErikEJ commented Jan 24, 2025

Trying to summarize the key selling points for the new wizard:

Improved developer UX with a familiar "wizard" experience for reverse engineering
Better indication and visibility of progress of background processes
More visible feedback in the new Summary dialog, if errors or warnings occur during code generation, with actionable instructions for remediation
Ability to move backwards and change options during a session
Ability to generate the code multiple time in the same session (stretch goal?)

@BillKrat
Copy link
Contributor

I'll put something together for your review

@ErikEJ
Copy link
Owner Author

ErikEJ commented Jan 24, 2025

This is for later, when we remove the legacy dialogs and code.

The wiki guide should be updated to reflect these advantages

@BillKrat
Copy link
Contributor

Note: we are not far from achieving these two goals - a few days worth of work at tops. I'll have it ready for when we remove legacy dialogs (or sooner if you like).

  • Ability to move backwards and change options during a session
  • Ability to generate the code multiple time in the same session (stretch goal?)

@ErikEJ
Copy link
Owner Author

ErikEJ commented Jan 24, 2025

There is no rush, now we can gather some feedback from my daily build early adopters and then I will publish a release to VS Marketplace to gather even more feedback.

@ErikEJ
Copy link
Owner Author

ErikEJ commented Jan 27, 2025

I'll have it ready for when we remove legacy dialogs (or sooner if you like).

@BillKrat Sooner would be nice, then it can get tested by early adopters

@ErikEJ ErikEJ added enhancement New feature or request reveng labels Jan 27, 2025
@BillKrat
Copy link
Contributor

@ErikEJ I submitted a PR for the following - they were low hanging fruit.

  • Ability to move backwards and change options during a session
  • Ability to generate the code multiple time in the same session (stretch goal?)

I'll start working on removing legacy dialogs.

@ErikEJ
Copy link
Owner Author

ErikEJ commented Jan 28, 2025

I'll start working on removing legacy dialogs

We need to release a new build to MarketPlace with both options available to collect feedback and iron out any bugs first. That will happen after patch Tuesday in Feb.

@BillKrat
Copy link
Contributor

@ErikEJ - I completed updates for the wizard - I removed legacy code and the wizard preview menu option. I tested each of the features successfully after my updates (at least to the extent of my limited knowledge of their uses; but did exercise the dialogs). I'll be submitted a PR that should have the code ready for you when you want to move to the next phase.

I think you captured the bullet points for the wizard features nicely, I can't think of anything to add and the recent PR took care of the last two bullet points; they will be ready for review and testing along with the wizard code.

  • Improved developer UX with a familiar "wizard" experience for reverse engineering
  • Better indication and visibility of progress of background processes
  • More visible feedback in the new Summary dialog, if errors or warnings occur during code generation, with actionable instructions for remediation
  • Ability to move backwards and change options during a session
  • Ability to generate the code multiple time in the same session

It is my understanding that this will complete our objectives for the Reverse Engineering Wizard. I'll be standing by to triage any issues that will require my attention - I'll let you make that determination, I'm at your disposal.

With that understanding I'll be moving on to my other open source project(s), please let me know if you require me to do anything else.

Best regards
Bill

@ErikEJ
Copy link
Owner Author

ErikEJ commented Feb 1, 2025

Great and thanks again for a huge contribution.

I will release a new version to marketplace this weekend so we can get your PR merged and collect any feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request reveng
Projects
None yet
Development

No branches or pull requests

2 participants