docs: Streamlined brand README#48
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #48 +/- ##
=======================================
Coverage 93.04% 93.04%
=======================================
Files 16 16
Lines 503 503
Branches 18 18
=======================================
Hits 468 468
Misses 24 24
Partials 11 11
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
|
||
| ### Local brand dev without Tutor | ||
|
|
||
| TODO write this section |
There was a problem hiding this comment.
2U's elm-theme includes a script in package.json that wraps the paragon serve-theme-css command
"serve-theme-css": "paragon serve-theme-css --theme-name 'Local Elm (edX.org)'",
Using the URLs from that command in a local env.config.js should do the trick
There was a problem hiding this comment.
Nice. I'll do that in a follow-up if that's cool.
|
|
||
| ### ***OR*** manually add to a `frontend-base` site's `site.config.tsx` | ||
| Add the following block to your `SiteConfig` object in `site.config.tsx` | ||
| If you are running a frontend-base site, configure its `env.config.js` to install this theme: |
There was a problem hiding this comment.
frontend-base doesn't use env.config.js. https://github.com/openedx/frontend-template-site and all the frontend-base branches of frontend-app-* repos include site.config.*.tsx files that already have SiteConfig objects, so not having a full example file here was intentional.
There was a problem hiding this comment.
Right, typo on my part. Should be fixed now.
kdmccormick
force-pushed
the
kdmccormick/brand-readme
branch
from
25e52e7 to
ea89d01
Compare
|
@brian-smith-tcril any objections to me merging this one? |
2 participants
Sorts the instructions in the README more explicitly and makes some steps more copy-able.
The only hole left is "Local brand dev without Tutor". I'm working on this now.
Preview: https://github.com/openedx/sample-plugin/blob/kdmccormick/brand-readme/brand-sample/README.md
No AI use.