Dcc usage docs - #44
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR expands the repository’s documentation to better explain how to use the MIT DCC (MIT SLM) badge-generation workflow in Open edX, including a detailed, screenshot-driven walkthrough and additional Sphinx docs structure.
Changes:
- Update the root README “Usage” section to point readers to a new step-by-step how-to and clarify admin configuration fields.
- Add a comprehensive how-to guide (with screenshots) for configuring profiles/scopes and using the AI Badges UI in Studio.
- Add/extend Sphinx documentation structure, including ADRs and autodoc pages for key Python packages.
Reviewed changes
Copilot reviewed 10 out of 16 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| README.rst | Adds a prominent link to the new DCC usage how-to and updates the summarized setup steps. |
| docs/how-tos/index.rst | Adds a toctree so how-to pages appear in built docs navigation. |
| docs/how-tos/generate_badges_with_dcc_models.rst | New end-to-end walkthrough for configuring and using the MIT DCC badge workflow (with screenshots and troubleshooting). |
| docs/decisions.rst | Replaces placeholder text with a toctree that includes ADRs. |
| docs/decisions/0001-offload-to-ai-extensions.rst | New ADR documenting architectural boundaries between this plugin and openedx-ai-extensions. |
| docs/openedx_ai_badges.workflows.rst | New autodoc page for workflows modules. |
| docs/openedx_ai_badges.processors.rst | New autodoc page for processor modules. |
| docs/openedx_ai_badges.events.rst | New autodoc page for events modules. |
| docs/openedx_ai_badges.edxapp_wrapper.rst | New autodoc page for edxapp_wrapper package. |
| docs/openedx_ai_badges.edxapp_wrapper.backends.rst | New autodoc page for edxapp_wrapper.backends package. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds documentation on usage of the mit-dcc orchestrator based on the shared docs at https://docs.google.com/document/d/1lsD8gbFsCkgxmZ4kx5ZGoG2UDZUOlmgG_2EsqgMxbe4/edit?tab=t.0