Skip to content

fix: update sidebar design#2852

Open
rpenido wants to merge 5 commits intoopenedx:masterfrom
open-craft:rpenido/fal-4297/update-help-sidebar-design
Open

fix: update sidebar design#2852
rpenido wants to merge 5 commits intoopenedx:masterfrom
open-craft:rpenido/fal-4297/update-help-sidebar-design

Conversation

@rpenido
Copy link
Contributor

@rpenido rpenido commented Jan 30, 2026

Description

This PR updates the help sidebar to match the current design.

  • Which user roles will this change impact?
    "Course Author"
Before After
image image

Supporting information

Testing instructions

  • Open the the course outline
  • Check the Help sidebar

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

  • Any new files are using TypeScript (.ts, .tsx).
  • Avoid propTypes and defaultProps in any new or modified code.
  • Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
  • Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
  • Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
  • All new i18n messages in messages.ts files have a description for translators to use.
  • Avoid using ../ in import paths. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

Private ref: FAL-4297

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 30, 2026
@openedx-webhooks
Copy link

openedx-webhooks commented Jan 30, 2026

Thanks for the pull request, @rpenido!

This repository is currently maintained by @bradenmacdonald.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@codecov
Copy link

codecov bot commented Jan 30, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.21%. Comparing base (f900ace) to head (511a796).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2852      +/-   ##
==========================================
+ Coverage   95.18%   95.21%   +0.03%     
==========================================
  Files        1319     1318       -1     
  Lines       30022    30018       -4     
  Branches     6748     6753       +5     
==========================================
+ Hits        28575    28582       +7     
- Misses       1378     1379       +1     
+ Partials       69       57      -12     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@rpenido rpenido marked this pull request as ready for review January 30, 2026 20:43
Copy link
Contributor

@navinkarkera navinkarkera left a comment

Choose a reason for hiding this comment

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

@rpenido Looks good.

@rpenido rpenido requested a review from ChrisChV February 3, 2026 18:05
@ChrisChV
Copy link
Contributor

ChrisChV commented Feb 3, 2026

@rpenido could you update the order of the sidebars?

Current

image

Expected

image

Copy link
Contributor

@ChrisChV ChrisChV left a comment

Choose a reason for hiding this comment

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

@rpenido Looks good! 👍 Fix the nit about the order to merge it 👍

@rpenido
Copy link
Contributor Author

rpenido commented Feb 3, 2026

Done! fddabe6

@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Feb 3, 2026
icon: Info,
title: messages.sidebarButtonInfo,
},
add: {
Copy link
Contributor

Choose a reason for hiding this comment

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

@rpenido The order is still not right. This happened during the merge with the master:

getOutlineSidebarPages is no longer used. Now the OutlineSidebarPagesContext pages are being used. This causes the order not to update, and another error occurs with the align sidebar:

https://www.loom.com/share/0c9bdcba827043259753eb80c4843d88

This happens because showAlignSidebar has to be retrieved inside a function, as getOutlineSidebarPages does.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @ChrisChV!
Fixed now! 10b24e8

I also fixed some flaky tests here: 511a796

@rpenido rpenido force-pushed the rpenido/fal-4297/update-help-sidebar-design branch 2 times, most recently from 1690c47 to 0a01de7 Compare February 4, 2026 20:31
@rpenido rpenido force-pushed the rpenido/fal-4297/update-help-sidebar-design branch from 0a01de7 to 51e3e4a Compare February 4, 2026 20:45
@rpenido rpenido force-pushed the rpenido/fal-4297/update-help-sidebar-design branch from 51e3e4a to 511a796 Compare February 4, 2026 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: In Eng Review

Development

Successfully merging this pull request may close these issues.

4 participants