Skip to content

Add focal point documentation to media library page#2930

Merged
pwizla merged 4 commits intomainfrom
user/media-library-focal-point
Feb 4, 2026
Merged

Add focal point documentation to media library page#2930
pwizla merged 4 commits intomainfrom
user/media-library-focal-point

Conversation

@markkaylor
Copy link
Contributor

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

@markkaylor markkaylor requested a review from pwizla as a code owner January 29, 2026 16:02
@vercel
Copy link

vercel bot commented Jan 29, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
documentation Ready Ready Preview, Comment Jan 30, 2026 2:27pm

Request Review

@github-actions github-actions bot added pr: chore source: repo PRs/issues not targeting a specific documentation but rather affecting the whole repo internal PRs created by the Strapi core team labels Jan 29, 2026
@markkaylor
Copy link
Contributor Author

markkaylor commented Jan 29, 2026

Looking into the broken links causing the build to fail done

@pwizla
Copy link
Collaborator

pwizla commented Jan 30, 2026

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.
Here's the detailed report generated.

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:

  • typos
  • adding a short intro sentence

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 Report

File: docusaurus/docs/cms/features/media-library.md
PR: #2930
Workflow: Full Review (Outline Checker → UX Analyzer → Style Checker)
Date: 2026-01-30


Summary

Check Errors Warnings Suggestions
Structure (Outline Checker) 0 0 0
UX (UX Analyzer) 0 0 1
Style (12 Rules) 2 1 0
Total 2 1 1

Suggestions

[suggestion] UX — Consider adding a brief intro sentence

Issue: The section jumps directly into steps without explaining what a focal point is or why a user would want one.

Current:

#### Adding a focal point
  1. Click on the edit...

Suggested improvement:

#### Adding a focal point

A focal point ensures the most important part of an image remains visible when the image is cropped or resized in different contexts.

  1. Click on the edit...

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 — Typo

Found: "...to abandaon changes and exit focal point mode."

Issue: Typo — "abandaon" should be "abandon".

Suggestion:

Alternatively, click the cancel <Icon name="x" classes="ph-bold" /> button to abandon changes and exit focal point mode.

[error] Section "Adding a focal point" > Step 5 — Typo

Found: "...to reset the focal point to the center of the iamge."

Issue: Typo — "iamge" should be "image".

Suggestion:

Click the reset <Icon name="arrows-counter-clockwise" classes="ph-bold" /> button to reset the focal point to the center of the image.

[warning] Section "Adding a focal point" > Step 4 — Rule 7: One step = one action

Found: "Click the check <Icon name="check" classes="ph-bold" /> button to validate the new focal point. Alternatively, click the cancel <Icon name="x" classes="ph-bold" /> button to abandon changes and exit focal point mode."

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:

4. Click the check <Icon name="check" classes="ph-bold" /> button to validate the new focal point.
5. Alternatively, to discard changes, click the cancel <Icon name="x" classes="ph-bold" /> button to exit focal point mode without saving.
6. Click the reset...
7. Click **Finish**...

Option B — Use a note/tip callout:

4. Click the check <Icon name="check" classes="ph-bold" /> button to validate the new focal point.

:::tip
To discard changes, click the cancel <Icon name="x" classes="ph-bold" /> button instead.
:::

  1. Click the reset...

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)

  1. [error] Fix typo: "abandaon" → "abandon" (Step 4)
  2. [error] Fix typo: "iamge" → "image" (Step 5)
  3. [warning] Consider splitting Step 4 into separate steps for validate/cancel actions, or use a callout for the alternative
  4. [suggestion] Add a brief intro sentence explaining what a focal point is and why it's useful

Assets Updated

The PR also updates two screenshots:

  • media-library_asset-details.png
  • media-library_asset-details_DARK.png

✅ Screenshot updates are appropriate to reflect the new focal point button in the UI.

@pwizla
Copy link
Collaborator

pwizla commented Jan 30, 2026

Looking great, thank you!

@pwizla pwizla self-assigned this Jan 30, 2026
@pwizla pwizla added this to the 6.15.1 milestone Jan 30, 2026
@pwizla pwizla removed the flag: merge pending release Pending Strapi Release label Feb 4, 2026
@pwizla pwizla merged commit 76424de into main Feb 4, 2026
4 of 5 checks passed
@pwizla pwizla deleted the user/media-library-focal-point branch February 4, 2026 15:33
pwizla added a commit that referenced this pull request Feb 4, 2026
* 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>
pwizla added a commit that referenced this pull request Feb 4, 2026
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal PRs created by the Strapi core team pr: chore source: repo PRs/issues not targeting a specific documentation but rather affecting the whole repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants