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?

modified main index.rst, added user_guide section, created section files (Intro, Setting up Project, FPGA input, SoC, input, Memory, Peripherals & Results) & lastly added subsection headings. User Guide's preliminary Table of Contents is created, it is separate from rest of the readthedocs content in to make it easier to modify.

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.

table of contents preview 10 31 2024
home page preview 10 31 2024

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

codecov bot commented Nov 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.83%. Comparing base (03e2e77) to head (8dfe5d8).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #256   +/-   ##
=======================================
  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.

@ravikiranchollangi ravikiranchollangi merged commit 7869ae6 into main Nov 1, 2024
19 checks passed
@ravikiranchollangi ravikiranchollangi deleted the user-guide-ToC branch November 1, 2024 14:55
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