Add focal point documentation to media library page#2930
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
|
b18d95f to
95b4c95
Compare
|
The PR looks great, @markkaylor! As an experiment, I passed it through new AI-based tools I'm developing to analyze compliance to our 12 rules and also to check the structure/outline. I'm fully aligned with it, except maybe about splitting Step 4. I think in our case it's perfectly acceptable to frame it as you did (what the bot calls "Option C"). I'll do these fixes myself:
and then I'll approve the PR, and merge it next Wednesday. 🫡 (Thanks for fixing the broken link which prevented the build, by the way. Another upcoming tool I'm developing will detect and fix this soon 🤓) Documentation Review ReportFile: Summary
Suggestions[suggestion] UX — Consider adding a brief intro sentenceIssue: The section jumps directly into steps without explaining what a focal point is or why a user would want one. Current:
Suggested improvement:
Impact: Low — the feature is intuitive enough, but a one-sentence intro would help users understand the value before following the steps. 3. Style Issues (Style Checker)[error] Section "Adding a focal point" > Step 4 — TypoFound: Issue: Typo — "abandaon" should be "abandon". Suggestion: [error] Section "Adding a focal point" > Step 5 — TypoFound: Issue: Typo — "iamge" should be "image". Suggestion: [warning] Section "Adding a focal point" > Step 4 — Rule 7: One step = one actionFound: Issue: This step contains two distinct actions (validate OR cancel). While they are alternatives, combining them in one step can cause confusion when users are following the procedure. Suggestion: Split into two separate steps or restructure: Option A — Split steps: Option B — Use a note/tip callout:
Option C — Keep as-is (acceptable): If the team prefers to keep alternative actions together for brevity, this is a minor deviation and can be accepted. The current phrasing with "Alternatively" does signal the optional nature. Recommended Fixes (by priority)
Assets UpdatedThe PR also updates two screenshots:
✅ Screenshot updates are appropriate to reflect the new focal point button in the UI. |
|
Looking great, thank you! |
* Add focal point documentation to media library page * Fix typos * Update docusaurus/docs/cms/features/media-library.md * Update docusaurus/docs/cms/features/media-library.md --------- Co-authored-by: Pierre Wizla <pwizla+github@gmail.com>
* Add focal point documentation to media library page * Fix typos * Update docusaurus/docs/cms/features/media-library.md * Update docusaurus/docs/cms/features/media-library.md --------- Co-authored-by: markkaylor <mark.kaylor@strapi.io>
Description
Updates the documentation for the Media Library to include the new focal point feature
Related issue(s)/PR(s)
More information about the feature on this PR
strapi/strapi#25267