docs: [BD-46] updated README file #3078

PKulkoRaccoonGang · 2024-05-20T13:29:17Z

Description

Added description of CSS foundation
Removed SCSS foundation text block (similar to the documentation site)
Changed Paragon CLI usage guide
Verified work Paragon CLI

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.

openedx-webhooks · 2024-05-20T13:29:21Z

Thanks for the pull request, @PKulkoRaccoonGang!

When this pull request is ready, tag your edX technical lead.

netlify · 2024-05-20T13:29:32Z

✅ Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`69976b4`
🔍 Latest deploy log	https://app.netlify.com/sites/paragon-openedx/deploys/664bbe6436cdfd0008118d8b
😎 Deploy Preview	https://deploy-preview-3078--paragon-openedx.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

codecov · 2024-05-20T13:40:12Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.68%. Comparing base (a2b552c) to head (69976b4).
Report is 402 commits behind head on alpha.

Additional details and impacted files

@@           Coverage Diff           @@
##            alpha    #3078   +/-   ##
=======================================
  Coverage   93.68%   93.68%           
=======================================
  Files         229      229           
  Lines        3740     3740           
  Branches      876      876           
=======================================
  Hits         3504     3504           
  Misses        232      232           
  Partials        4        4

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

brian-smith-tcril

Overall these changes are looking great! I left a couple comments, let me know what you think!

brian-smith-tcril · 2024-05-20T14:28:01Z

README.md

+**Usage with no theme:**

-**index.scss**
+The Paragon CSS Foundation offers a collection of fundamental styles, encompassing padding, typography, and sizing.
+When applied, these styles contribute to the creation of a straightforward and neat appearance for your application.
+
+To integrate these foundational styles into your project, include the following import:

 ```
-// ... Any custom SCSS variables should be defined here
-@import '~@openedx/paragon/styles/scss/core/core.scss';
+@use "@openedx/paragon/dist/core.min.css";
 ```

-Usage on with `@edx/brand`:
+**Usage with a theme:**
+
+In addition to the basic styles, you can provide a theme layer that includes styles for colors, shadows, backgrounds
+and transparency of elements. This allows you to visually represent a specific theme in your application.

-**index.scss**
+To apply these theme-specific styles, include the following import:

 ```
-@import '~@edx/brand/paragon/fonts.scss';
-@import '~@edx/brand/paragon/variables.scss';
-@import '~@openedx/paragon/styles/scss/core/core.scss';
-@import '~@edx/brand/paragon/overrides.scss';
+@use "@my-brand/light.min.css";
 ```


I feel like this section is a bit ambiguous. It's not clear if someone wanting to use a theme should have

@use "@openedx/paragon/dist/core.min.css"; @use "@my-brand/light.min.css";

or just

@use "@my-brand/light.min.css";

Yes, I agree
The first variant will be more understandable
Thank you!

brian-smith-tcril · 2024-05-20T14:31:13Z

README.md


 ## Paragon CLI

 The Paragon CLI (Command Line Interface) is a tool that provides various utility commands to automate actions within the Open edX environment.

 ### Available Commands

- `paragon install-theme [theme]`: Installs the specific [brand package](https://github.com/openedx/brand-openedx).
+- `paragon install-theme`: Installs the specific [brand package](https://github.com/openedx/brand-openedx).


With the argument [theme] removed the wording of "the specific brand package" feels a bit unclear. Maybe having it just be

Suggested change

- `paragon install-theme`: Installs the specific [brand package](https://github.com/openedx/brand-openedx).

- `paragon install-theme`: Install a [brand package](https://github.com/openedx/brand-openedx).

would clear it up?

Yes, corrected

openedx-semantic-release-bot · 2024-06-17T16:25:47Z

🎉 This PR is included in version 23.0.0-alpha.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

openedx-semantic-release-bot · 2024-12-12T02:34:23Z

🎉 This PR is included in version 23.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

openedx-webhooks added the blended PR is managed through 2U's blended developmnt program label May 20, 2024

PKulkoRaccoonGang self-assigned this May 20, 2024

PKulkoRaccoonGang requested a review from ihor-romaniuk May 20, 2024 13:35

docs: updated README file

1c6c4a7

PKulkoRaccoonGang force-pushed the Peter_Kulko/update-readme branch from d3eeef3 to 1c6c4a7 Compare May 20, 2024 13:42

PKulkoRaccoonGang requested a review from brian-smith-tcril May 20, 2024 13:46

ihor-romaniuk approved these changes May 20, 2024

View reviewed changes

brian-smith-tcril reviewed May 20, 2024

View reviewed changes

refactor: after review

69976b4

PKulkoRaccoonGang requested a review from brian-smith-tcril May 20, 2024 21:19

PKulkoRaccoonGang mentioned this pull request May 21, 2024

Update local docs in the paragon repo #3060

Closed

brian-smith-tcril approved these changes May 21, 2024

View reviewed changes

brian-smith-tcril merged commit a88f5eb into openedx:alpha May 21, 2024
10 checks passed

openedx-semantic-release-bot added the released on @alpha label Jun 17, 2024

PKulkoRaccoonGang mentioned this pull request Jul 2, 2024

Write general documentation of usage #3068

Open

PKulkoRaccoonGang added a commit that referenced this pull request Aug 4, 2024

docs: [BD-46] updated README file (#3078)

cd9479a

PKulkoRaccoonGang added a commit that referenced this pull request Aug 4, 2024

docs: [BD-46] updated README file (#3078)

34e2bb0

PKulkoRaccoonGang added a commit that referenced this pull request Aug 5, 2024

docs: [BD-46] updated README file (#3078)

8a4cc42

openedx-semantic-release-bot added the released label Dec 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: [BD-46] updated README file #3078

docs: [BD-46] updated README file #3078

PKulkoRaccoonGang commented May 20, 2024 •

edited

Loading

openedx-webhooks commented May 20, 2024

netlify bot commented May 20, 2024 •

edited

Loading

codecov bot commented May 20, 2024 •

edited

Loading

brian-smith-tcril left a comment

brian-smith-tcril May 20, 2024

PKulkoRaccoonGang May 20, 2024

brian-smith-tcril May 20, 2024 •

edited

Loading

PKulkoRaccoonGang May 20, 2024

openedx-semantic-release-bot commented Jun 17, 2024

openedx-semantic-release-bot commented Dec 12, 2024

	- `paragon install-theme`: Installs the specific [brand package](https://github.com/openedx/brand-openedx).
	- `paragon install-theme`: Install a [brand package](https://github.com/openedx/brand-openedx).

docs: [BD-46] updated README file #3078

docs: [BD-46] updated README file #3078

Conversation

PKulkoRaccoonGang commented May 20, 2024 • edited Loading

Description

Merge Checklist

Post-merge Checklist

openedx-webhooks commented May 20, 2024

netlify bot commented May 20, 2024 • edited Loading

✅ Deploy Preview for paragon-openedx ready!

codecov bot commented May 20, 2024 • edited Loading

Codecov Report

brian-smith-tcril left a comment

Choose a reason for hiding this comment

brian-smith-tcril May 20, 2024

Choose a reason for hiding this comment

PKulkoRaccoonGang May 20, 2024

Choose a reason for hiding this comment

brian-smith-tcril May 20, 2024 • edited Loading

Choose a reason for hiding this comment

PKulkoRaccoonGang May 20, 2024

Choose a reason for hiding this comment

openedx-semantic-release-bot commented Jun 17, 2024

openedx-semantic-release-bot commented Dec 12, 2024

PKulkoRaccoonGang commented May 20, 2024 •

edited

Loading

netlify bot commented May 20, 2024 •

edited

Loading

codecov bot commented May 20, 2024 •

edited

Loading

brian-smith-tcril May 20, 2024 •

edited

Loading