Milestone 1: Plugin Scaffolding and Configuration Setup

[Alec4r]

🚀 Description

This PR introduces the initial setup and functionality for the tutor-contrib-paragon plugin.

✅ Summary of changes

1. chore: add CI workflow and local development tooling

• Adds a GitHub Actions CI workflow that runs only when changes are made in the plugin's directory (supports monorepo structure).

• Includes local development tools:

  • pytest for future test coverage
  • Makefile targets for development (make run-tests, make dev-requirements, etc.)

2. feat: create theme folders from config and document structure

• Adds logic to automatically create the following folders based on Tutor config values:

  • PARAGON_THEME_SOURCES_PATH → where theme source files (Style Dictionary) are placed
  • PARAGON_COMPILED_THEMES_PATH → where compiled theme CSS will be stored

• Ensures folders are created during tutor plugins enable, tutor config save, etc.

• Adds a detailed README.rst explaining the plugin's structure, purpose, configuration, and future direction

📘 Context

This is the foundation for the Paragon theme management plugin, which will later include a build service (paragon-compiler) and a CLI task.

[openedx-webhooks]

Thanks for the pull request, @Alec4r!

This repository is currently maintained by @arbrandes.

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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.

[Alec4r]

@brian-smith-tcril could you help me here, please?

[brian-smith-tcril]

Overall this looks like great scaffolding!

I'm not sure how much fits into this milestone (Milestone 1) vs the later milestones.

I know Milestone 3 includes hosting the generated CSS files - is there any scaffolding that should be done for that now?

I'm also not sure how much documentation should happen here.

If those are planned to be part of the future milestones that's great, and my comments about documentation can be non-blocking.

[Alec4r]

Overall this looks like great scaffolding!

I'm not sure how much fits into this milestone (Milestone 1) vs the later milestones.

I know Milestone 3 includes hosting the generated CSS files - is there any scaffolding that should be done for that now?

I'm also not sure how much documentation should happen here.

If those are planned to be part of the future milestones that's great, and my comments about documentation can be non-blocking.

I've added the default settings and some initial documentation to help get this project started. These will continue to evolve as we move through the next milestones.

I also incorporated several of your recommendations, thank you very much for the thoughtful review!

[brian-smith-tcril]

we recommend doing so via extensions in the theme source directory

It'd be great to link out to documentation on how to use extensions. I didn't see anything about that mentioned in openedx/brand-openedx#26 or https://github.com/openedx/paragon/?tab=readme-ov-file#design-tokens, so this can wait until after those docs are written.

[Alec4r]

Great point! I’ll add a link to the docs once they’re published. For now I’ll leave the mention as a placeholder.

[brian-smith-tcril]

LGTM!

[arbrandes]

Looks great! I didn't even know it was possible to run workflows selectively, like this. Awesome!