-
-
Notifications
You must be signed in to change notification settings - Fork 834
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
Add README documentation to ExtensionPage #3094
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All looks good on the whole, just a few nitpicks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving based on my experiences inside our hosting stack.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the frontend a lot, and think this would be a great feature. From a code organization perspective, I'm not sure that the controller directly is the best place for this implementation to live. I'm also hesitant to add new endpoints that are far from complying with the JSON:API spec if not necessary. Left some ideas in the code.
So @askvortsov1 and I discussed this again today. We decided to simplify things a little and not go down the whole boilerplate building excercise just yet. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks good, the one thought I have is possibly changing extensions-readme
to extension-readmes
to show that it's plural in the readmes, not the extensions.
Co-authored-by: Alexander Skvortsov <[email protected]>
Thank you so much for this! |
Changes proposed in this pull request:
Adds a button to display an extensions
README
file within a modal directly from theExtensionPage
Reviewers should focus on:
This is almost a "lift and shift" from
blomstra/readme
. Did I forget any core conventions when migrating this?Screenshot
Confirmed
composer test
).