Skip to content

Clarify image paths for nested assets - #7158

Open
hamedrabah wants to merge 1 commit into
mintlify:mainfrom
hamedrabah:docs/nested-image-paths
Open

Clarify image paths for nested assets#7158
hamedrabah wants to merge 1 commit into
mintlify:mainfrom
hamedrabah:docs/nested-image-paths

Conversation

@hamedrabah

@hamedrabah hamedrabah commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Documentation changes

Clarifies how to keep images beside related pages while using Mintlify root-relative paths:

  • Shows a nested guides/assets directory example.
  • Provides the exact path to use from MDX.
  • States that no global image-directory setting is required.

Closes #175

Validation

  • mint validate --telemetry=false
  • mint broken-links --files create/image-embeds.mdx --telemetry=false
  • git diff --check

Note

Low Risk
Documentation-only clarification in create/image-embeds.mdx; no product or runtime behavior changes.

Overview
Expands the “Basic image syntax” section in create/image-embeds.mdx so authors can colocate images (e.g. guides/assets/ next to setup.mdx) without guessing how paths work.

The new copy adds a sample repo tree, shows the MDX path /guides/assets/setup-dialog.png from any page, and states that no global image-directory setting is required—still using repository root-relative paths only (not ./ relative paths).

Reviewed by Cursor Bugbot for commit cd1f974. Bugbot is set up for automated code reviews on this repo. Configure here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

About the relative path of the images

1 participant