docs(author-profile): add block README#2310
Conversation
There was a problem hiding this comment.
Pull request overview
Adds developer-facing documentation for the author-profile Gutenberg block, describing operating modes, rendering behavior, attributes, bindings, and editor UX.
Changes:
- Introduces
src/blocks/author-profile/README.mdexplaining the Author Profile block’s modes and rendering strategy. - Documents block attributes and block bindings keys.
- Adds “Related” links to companion blocks/templates.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
All flagged items reference code (variations, templates, |
laurelfulford
left a comment
There was a problem hiding this comment.
This looks good @rbcorrales! I just flagged one line that may need to be clipped depending on how the feedback in the variation picker PR is handled, but I don't think that's a blocker since this is correct for how it works right now, and the text can be changed after the behaviour's changed :)
|
Hey @rbcorrales, good job getting this PR merged! 🎉 Now, the Please check if this PR needs to be included in the "Upcoming Changes" and "Release Notes" doc. If it doesn't, simply remove the label. If it does, please add an entry to our shared document, with screenshots and testing instructions if applicable, then remove the label. Thank you! ❤️ |
All Submissions:
Changes proposed in this Pull Request:
Adds a developer-facing README for the Author Profile block.
Closes NPPD-1220.
How to test the changes in this Pull Request:
src/blocks/author-profile/README.mdand verify the content renders correctly on GitHub.Other information: