Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve explanation of patches in V1 Plugin API docs #29

Open
Tracked by #123
kdmccormick opened this issue Jun 16, 2022 · 2 comments
Open
Tracked by #123

Improve explanation of patches in V1 Plugin API docs #29

kdmccormick opened this issue Jun 16, 2022 · 2 comments
Assignees
Labels
documentation Relates to documentation improvements tutor Requires a change to Tutor

Comments

@kdmccormick
Copy link
Member

kdmccormick commented Jun 16, 2022

Background

Based on this Slack conversation: https://openedx.slack.com/archives/C02V3GHE3UP/p1655384231694799

Essentially, the v0 API docs put the concept of "patches" front-and-center, and had a nice little explanation of them. The equivalent V1 docs for patches are nested under Reference -> Hooks API -> Constants, and they are very basic. There is a Template Patches reference page, but it does not explain patches, it just lists them.

Tasks

Make it so it's easier for new plugin developers to understand what a patch is. This could involve adding a new docs section, improving the existing ones, or both.

@MaferMazu
Copy link

I can work on this @kdmccormick

@kdmccormick kdmccormick changed the title Improve explanation of patches in V1 Plugin API docs? Improve explanation of patches in V1 Plugin API docs Mar 15, 2023
@kdmccormick kdmccormick added the documentation Relates to documentation improvements label May 31, 2023
@MaferMazu
Copy link

I started this work here: overhangio/tutor#852

@kdmccormick kdmccormick transferred this issue from openedx-unsupported/wg-developer-experience Mar 28, 2024
@kdmccormick kdmccormick added the tutor Requires a change to Tutor label Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to documentation improvements tutor Requires a change to Tutor
Projects
No open projects
Status: Refined
Development

No branches or pull requests

2 participants