openedx / frontend-app-discussions

A React-based micro frontend for the Open edX discussion forums.
GNU Affero General Public License v3.0
6 stars 64 forks source link

feat: added help section for post documentation #733

Closed sundasnoreen12 closed 3 months ago

sundasnoreen12 commented 3 months ago

INF-821

Description

To improve learner access to documentation about mathjax and forums in general, we introduced links to these docs within the text editor as show in option #7 of this mockup: Discussions and shown below.

Clicking on the “?” icon at the bottom right of the text editor will open a help menu. Users should be able to close it, similar to preview.

Links to 2 docs will be shown initially, but more may be added later.

The “Participating in course discussions” will point to this link: Participating in Course Discussions – edX Help Center

The “Entering math expressions in course discussions” will point to this link: Entering math expressions in course discussions

Screenshots/sandbox (optional):

Screenshot 2024-08-07 at 10 56 44 PM Screenshot 2024-08-07 at 10 56 20 PM

Merge Checklist

Post-merge Checklist

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 93.18%. Comparing base (4297a96) to head (ab1b07e).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #733 +/- ## ========================================== + Coverage 93.16% 93.18% +0.01% ========================================== Files 160 161 +1 Lines 3396 3404 +8 Branches 921 919 -2 ========================================== + Hits 3164 3172 +8 Misses 214 214 Partials 18 18 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.