Skip to content

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)

What does this pull request change?

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
@MustafaAbdaal MustafaAbdaal added the documentation Improvements or additions to documentation label Nov 19, 2024
@codecov
Copy link

codecov bot commented Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.83%. Comparing base (94140f9) to head (192ed7a).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #269   +/-   ##
=======================================
  Coverage   68.83%   68.83%           
=======================================
  Files         110      110           
  Lines        9022     9022           
  Branches      402      402           
=======================================
  Hits         6210     6210           
  Misses       2812     2812           

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


🚨 Try these New Features:

@ravikiranchollangi ravikiranchollangi merged commit f7aa4b6 into main Nov 19, 2024
11 checks passed
@ravikiranchollangi ravikiranchollangi deleted the user-guide-ToC branch November 19, 2024 21:23
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.

3 participants