Uh oh!
There was an error while loading. Please reload this page.
docs: Rework READMEs - #52
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@## main #52 +/- ##
=======================================
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:
|
kdmccormickforce-pushed
the
kdmccormick/readmes
branch
from
May 18, 2026 16:05
7ac93bd to
82438f4CompareCo-Authored-By: Claude Opus 4.7 (1M Context) <noreply@anthropic.com>
kdmccormickforce-pushed
the
kdmccormick/readmes
branch
from
May 18, 2026 16:06
82438f4 to
b8f46f5Comparekdmccormick
marked this pull request as ready for review
May 18, 2026 16:07
Co-Authored-By: Claude Opus 4.7 (1M Context) <noreply@anthropic.com>
feanil
approved these changes
May 18, 2026
Uh oh!
There was an error while loading. Please reload this page.
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 freeto 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.
WIP
Preview: https://github.com/openedx/sample-plugin/blob/kdmccormick/readmes/README.md
Written by Claude from this prompt:
Hi, I'd like to rework all READMEs (excluding the one in docs/decisions).
General principles:
Here's my proposed structure--loosely, these are ideas, not headings. Feel free to suggest alternatives and discuss with me.
./README.rst<sub-plugin>/README.rstOther guidance: