Skip to content

GUI Documentation Update #3256

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Aug 28, 2025
Merged

GUI Documentation Update #3256

merged 4 commits into from
Aug 28, 2025

Conversation

SamuelHo10
Copy link
Contributor

I've revised the internal blocks and critical path documentation, and updated several of the images.

@github-actions github-actions bot added VPR VPR FPGA Placement & Routing Tool docs Documentation labels Aug 27, 2025
@SamuelHo10 SamuelHo10 requested a review from vaughnbetz August 27, 2025 21:47
vaughnb-cerebras
vaughnb-cerebras approved these changes Aug 27, 2025
View reviewed changes
Copy link

@vaughnb-cerebras vaughnb-cerebras left a comment

Choose a reason for hiding this comment

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

Looks great, thanks @SamuelHo10 !

@vaughnb-cerebras
Copy link

If you've got the energy for a few more minor updates:

  • Initial placement screenshot should be regenerated so it shows the new menu names
  • ' under the Misc. tab and press Done. ' --> Done should be 'Next Step'
  • 'Button Description Table' --> 'Feature Description Table'
    • Should also remove 'toggle' from the features listed (e.g. 'Toggle Nets' should be 'Nets')

@vaughnbetz vaughnbetz merged commit 98065e9 into master Aug 28, 2025
30 checks passed
@vaughnbetz vaughnbetz deleted the gui_docs branch August 28, 2025 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vaughnbetz vaughnbetz Awaiting requested review from vaughnbetz

1 more reviewer

@vaughnb-cerebras vaughnb-cerebras vaughnb-cerebras approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
docs Documentation VPR VPR FPGA Placement & Routing Tool
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@SamuelHo10 @vaughnb-cerebras @vaughnbetz