Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions create/image-embeds.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Images and embeds"
description: "Add images, videos, andiframes."

Check warning on line 3 in create/image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L3

Did you really mean 'andiframes'?

Check warning on line 3 in create/image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L3

'iframes' should use sentence-style capitalization.
keywords: ["images", "videos", "iframes", "media"]
---

Expand All @@ -27,12 +27,12 @@
```

<Tip>
Always include descriptive alt text to improve accessibility and SEO. The alt text should clearly describe what the image shows.

Check warning on line 30 in create/image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L30

Spell out 'SEO', if it's unfamiliar to the audience.
</Tip>

Image files must be less than 20 MB. For larger files, host them on a CDN service like [Amazon S3](https://aws.amazon.com/s3) or [Cloudinary](https://cloudinary.com).

Check warning on line 33 in create/image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L33

Spell out 'CDN', if it's unfamiliar to the audience.

### HTML image embeds

Check warning on line 35 in create/image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L35

'HTML image embeds' should use sentence-style capitalization.

For more control over image display, use HTML `<img>` tags:

Expand All @@ -57,9 +57,9 @@
/>
```

#### Disable zoom functionality

Check warning on line 60 in create/image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L60

Use 'capability' or 'feature' instead of 'functionality'.

To disable the default zoom on click for images, add the `noZoom` property:

Check warning on line 62 in create/image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L62

Use 'turn off' or 'off' instead of 'disable'.

```html highlight="4"
<img
Expand All @@ -84,7 +84,7 @@
```

<Note>
Images within anchor tags automatically display a pointer cursor to indicate they are clickable.

Check warning on line 87 in create/image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L87

Use 'they're' instead of 'they are'.
</Note>

#### Light and dark mode images
Expand Down Expand Up @@ -124,8 +124,7 @@
className="w-full aspect-video rounded-xl"
src="https://www.youtube.com/embed/4KzFe50RQkQ"
title="YouTube video player"
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"

Check warning on line 127 in create/image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L127

Use semicolons judiciously.

Check warning on line 127 in create/image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L127

Use semicolons judiciously.

Check warning on line 127 in create/image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L127

Use semicolons judiciously.

Check warning on line 127 in create/image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L127

Use semicolons judiciously.

Check warning on line 127 in create/image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L127

Use semicolons judiciously.
allowFullScreen
></iframe>
```
Expand All @@ -135,7 +134,6 @@
className="w-full aspect-video rounded-xl"
src="https://www.youtube.com/embed/4KzFe50RQkQ"
title="YouTube video player"
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowFullScreen
></iframe>
Expand All @@ -153,7 +151,7 @@
></video>
```

### Autoplay videos

Check warning on line 154 in create/image-embeds.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L154

'Autoplay videos' should use sentence-style capitalization.

To autoplay a video, use:

Expand Down
10 changes: 7 additions & 3 deletions integrations/privacy/osano.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,23 @@

```json Integration options in docs.json
"integrations": {
"osano": "SOURCE"
"osano": {
"scriptSource": "SOURCE"
}
}
```

```json Example
"integrations": {
"osano": "https://cmp.osano.com/2sUB2dqwqdkks/8dqwd-dwd86£-4a9b/osano.js"
"osano": {
"scriptSource": "https://cmp.osano.com/2sUB2dqwqdkks/8dqwd-dwd86£-4a9b/osano.js"
}
}
```

</CodeGroup>

The `SOURCE` can be found as the `src` value in the code snippet generated by Osano. It always starts with `https://cmp.osano.com/`.
The `scriptSource` value can be found as the `src` value in the code snippet generated by Osano. It always starts with `https://cmp.osano.com/` and ends with `/osano.js`.

Check warning on line 29 in integrations/privacy/osano.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/privacy/osano.mdx#L29

In general, use active voice instead of passive voice ('be found').

```html Code snippet from Osano
<script src="https://cmp.osano.com/placeholder/placeholder/osano.js"/>
Expand Down
2 changes: 1 addition & 1 deletion integrations/support/intercom.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Add the following to your `docs.json` file to add an [Intercom](https://www.inte
```json Example
"integrations": {
"intercom": {
"appId": "APP_ID"
"appId": "abc123def4"
}
}
```
Expand Down