Skip to content

FPGA input fields, added explanation and defaults as well as fixed few labels #281

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

Merged
merged 16 commits into from
Nov 28, 2024

Conversation

MustafaAbdaal
Copy link
Collaborator

Motivate of the pull request

  • To address an existing issue. If so, please provide a link to the issue:
  • Breaking new feature. If so, please describe details in the description part.

Describe the technical details

What is currently done? (Provide issue link if applicable)

Had previously given instructions and images for user to fill input fields, but it lacked explicit input instructions for each field.

What does this pull request change?

FPGA input sections - clocking, fle, BRAM, DSP, IO. Have added lists on each section showing the user how to fill out the input fields as well as mentioned default values and explanations of certain fields. In addition, fixed a few labels after running walkthrough on teams.

Which part of the code base require a change

  • Frontend:
  • Backend:
  • Library: <Specify the library name, e.g. npm packages>
  • Plug-in: <Specify the plugin name, e.g. Webpack, jtest>
  • Documentation
  • Regression tests
  • Continuous Integration (CI) scripts

Impact of the pull request

  • Require a change on Quality of Results (QoR)
  • Break backward-compatibility. If so, please list who may be influenced.

To keep the user_guide table of contents easy to modify, I created a seperate user_guide folder with it's own index.rst, the file shows the sections covering basic RPE usage. As a starting point files for each section are located within the same user_guide folder, they will be moved to their own directories with respective index.rst files once subsections are finalized.
Subsections were added to the following sections: Setting up .RPE Project, FPGA input, SoC input, Analyzing Results. For now subsections will not be needed on Peripheral Usage & Memory Usage sections.
…. Rearranged subsections to align with RPE excel sheet's input order
…rmatted and content to be refined, but all info/steps have been covered
…re explicit instructions to follow in next commit
@MustafaAbdaal MustafaAbdaal added the documentation Improvements or additions to documentation label Nov 28, 2024
Copy link

codecov bot commented Nov 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.78%. Comparing base (f37bb87) to head (d012b2a).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #281   +/-   ##
=======================================
  Coverage   68.78%   68.78%           
=======================================
  Files         110      110           
  Lines        9035     9035           
  Branches      402      402           
=======================================
  Hits         6215     6215           
  Misses       2820     2820           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@ravikiranchollangi ravikiranchollangi merged commit 302c18b into main Nov 28, 2024
11 checks passed
@ravikiranchollangi ravikiranchollangi deleted the user-guide-ToC branch November 28, 2024 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants