Skip to content

docs: improve help text for --defaultThemeVariants CLI flag - #4154

Merged
brian-smith-tcril merged 2 commits into
openedx:release-23.xfrom
raccoongang:Peter_Kulko/document-default-theme-variants
Apr 16, 2026
Merged

docs: improve help text for --defaultThemeVariants CLI flag#4154
brian-smith-tcril merged 2 commits into
openedx:release-23.xfrom
raccoongang:Peter_Kulko/document-default-theme-variants

Conversation

@peterkulko

Copy link
Copy Markdown
Contributor

Description

Rewrites the --defaultThemeVariants help text for the build-scss CLI command to explain what the flag actually does, why you'd use it, and what happens to non-default variants

Issue: #3953

Merge Checklist

  • If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.
  • Does your change adhere to the documented style conventions?
  • Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
  • Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
  • Were your changes tested in the example app?
  • Is there adequate test coverage for your changes?
  • Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please request an a11y review for the PR in the #wg-paragon Open edX Slack channel.

Post-merge Checklist

  • Verify your changes were released to NPM at the expected version.
  • If you'd like, share your contribution in #show-and-tell.
  • 🎉 🙌 Celebrate! Thanks for your contribution.

@peterkulko peterkulko self-assigned this Mar 4, 2026
@netlify

netlify Bot commented Mar 4, 2026

Copy link
Copy Markdown

Deploy Preview for paragon-openedx-v23 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 64d3362
🔍 Latest deploy log https://app.netlify.com/projects/paragon-openedx-v23/deploys/69e0ea4a24a5990008943393
😎 Deploy Preview https://deploy-preview-4154--paragon-openedx-v23.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 4, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @PKulkoRaccoonGang!

This repository is currently maintained by @openedx/committers-paragon.

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

codecov Bot commented Mar 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.40%. Comparing base (dfc69e2) to head (64d3362).
⚠️ Report is 37 commits behind head on release-23.x.

Additional details and impacted files
@@               Coverage Diff                @@
##           release-23.x    #4154      +/-   ##
================================================
+ Coverage         94.39%   94.40%   +0.01%     
================================================
  Files               242      242              
  Lines              4296     4306      +10     
  Branches           1020      981      -39     
================================================
+ Hits               4055     4065      +10     
  Misses              237      237              
  Partials              4        4              

☔ 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.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Mar 5, 2026

@brian-smith-tcril brian-smith-tcril left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is great! One tiny comment with a question/suggestion.

Comment thread bin/paragon-scripts.js Outdated
Comment on lines +198 to +199
requiring explicit configuration. Variants not listed as defaults are still built and
available but must be explicitly selected by the consuming application.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It's not clear what

Variants not listed as defaults are still built and available but must be explicitly selected by the consuming application.
means here. Specifically what "explicitly selected" means.

I think the description is already strong without that sentence. How would you feel about just not including it?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Agreed, removed

@peterkulko
peterkulko force-pushed the Peter_Kulko/document-default-theme-variants branch from bdb37c8 to 64d3362 Compare April 16, 2026 13:55
@brian-smith-tcril
brian-smith-tcril merged commit 9e806b3 into openedx:release-23.x Apr 16, 2026
10 checks passed
@github-project-automation github-project-automation Bot moved this from In Eng Review to Done in Contributions Apr 16, 2026
@openedx-semantic-release-bot

Copy link
Copy Markdown

🎉 This PR is included in version 23.21.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

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 released

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

6 participants