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
4 changes: 2 additions & 2 deletions create/changelogs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,18 +95,18 @@
</Frame>

<Tip>
The table of contents and changelog filters are hidden when using `custom`, `center`, or `wide` page modes. Learn more about [page modes](/organize/pages#page-mode).
Using `custom`, `center`, or `wide` page modes hides the table of contents and changelog filters. Learn more about [page modes](/organize/pages#page-mode).
</Tip>

### Subscribable changelogs

Check warning on line 101 in create/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/changelogs.mdx#L101

Did you really mean 'Subscribable'?

<Note>RSS feeds are only available on public documentation.</Note>

Use `Update` components to create a subscribable RSS feed at your page URL with `/rss.xml` appended. For example, `mintlify.com/docs/changelog/rss.xml`.

Check warning on line 105 in create/changelogs.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/changelogs.mdx#L105

Did you really mean 'subscribable'?

The RSS feed publishes entries when you add new `Update` components and when modify headings inside of existing `Update` components.

RSS feed entries contain pure Markdown only. Components, code, and HTML elements are excluded. Use the `rss` property to provide alternative text descriptions for RSS subscribers when your updates include content that is excluded.
RSS feed entries contain pure Markdown only. They exclude components, code, and HTML elements. Use the `rss` property to provide alternative text descriptions for RSS subscribers when your updates contain excluded content.

```xml Example RSS feed
<?xml version="1.0" encoding="UTF-8"?>
Expand Down
2 changes: 1 addition & 1 deletion create/image-embeds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@

<Frame>
<img
className="rounded-xl"

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L11

Use 'classnames?' instead of 'className'.
src="https://mintlify-assets.b-cdn.net/bigbend.jpg"

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L12

Use 'HTTPS?' instead of 'https'.
alt="Photograph of a scenic landscape with purple flowers in the foreground, mountains in the background, and a blue sky with scattered clouds."
/>
</Frame>
Expand All @@ -32,7 +32,7 @@

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).

### 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 Down Expand Up @@ -130,7 +130,7 @@
className="w-full aspect-video rounded-xl"
src="https://www.youtube.com/embed/4KzFe50RQkQ"
title="YouTube video player"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L133

Use semicolons judiciously.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L133

Use semicolons judiciously.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L133

Use semicolons judiciously.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L133

Use semicolons judiciously.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L133

Use semicolons judiciously.
allowFullScreen
></iframe>
```
Expand Down Expand Up @@ -176,7 +176,7 @@
When using JSX syntax, write double-word attributes in camelCase: `autoPlay`, `playsInline`, `allowFullScreen`.
</Note>

## iframes
## Iframes

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

create/image-embeds.mdx#L179

Use 'iframes?' instead of 'Iframes'.

Embed external content using iframe elements:

Expand Down
4 changes: 2 additions & 2 deletions deploy/ghes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

#### Firewall configuration

The following outbound connections must be allowed:

Check warning on line 27 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L27

In general, use active voice instead of passive voice ('be allowed').
- Connections from Mintlify's static IP: `54.242.90.151`
- HTTPS (port 443) to Mintlify's service domains
- DNS resolution for Mintlify's service domains
Expand Down Expand Up @@ -61,7 +61,7 @@

<Steps>
<Step title="Set repository permissions">
Set the following permissions for the app. No Organization, Account, or Enterprise permissions are required:

Check warning on line 64 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L64

In general, use active voice instead of passive voice ('are required').

- **Checks:** Read and write
- **Contents:** Read and write
Expand Down Expand Up @@ -90,7 +90,7 @@
<Step title="Create the app">
Click **Create GitHub App**.

You'll be redirected to the app's settings page.

Check warning on line 93 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L93

In general, use active voice instead of passive voice ('be redirected').
</Step>

<Step title="Generate private key">
Expand Down Expand Up @@ -123,7 +123,7 @@
- **Only select repositories** (choose specific repositories)

<Tip>
We recommend selecting "Only select repositories" and limiting the app to only the repositories where your documentation is located.

Check warning on line 126 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L126

In general, use active voice instead of passive voice ('is located').
</Tip>
</Step>

Expand Down Expand Up @@ -158,12 +158,12 @@
- App client ID: (from step 3)
- App client secret: (from step 3)
- Installation ID: (from step 4)
- Private key: The entire contents of the `.pem` file (should be shared via secure file transfer)

Check warning on line 161 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L161

In general, use active voice instead of passive voice ('be shared').
- Webhook secret: (from step 5)

### Optional credentials for troubleshooting
- Organization name: Your GitHub organization name
- Repository names: Specific repositories where the app is installed

Check warning on line 166 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L166

In general, use active voice instead of passive voice ('is installed').
- GitHub Enterprise Server version: Found in your site admin dashboard

## Mintlify connection
Expand All @@ -172,7 +172,7 @@
- Integrate your GHES environment with an existing Mintlify deployment.
- Integrate your GHES environment with a new Mintlify deployment that we provision for you.

After your GHES environment is integrated with a Mintlify deployment, you are ready to enable webhooks for your GitHub App.

Check warning on line 175 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L175

In general, use active voice instead of passive voice ('is integrated').

<Note>
The webhook URL may change based on our configuration. We test the integration and provide you with the new URL.
Expand All @@ -194,7 +194,7 @@
</Step>
</Steps>

## FAQ and Troubleshooting
## FAQ and troubleshooting

<AccordionGroup>
<Accordion title="The app installation is failing with permission errors.">
Expand All @@ -208,7 +208,7 @@
<Accordion title="Webhooks aren't being delivered">
- Verify the webhook URL is correct and accessible.
- Ensure your firewall allows outbound HTTPS connections.
- Check the webhook secret matches what was configured.

Check warning on line 211 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L211

In general, use active voice instead of passive voice ('was configured').
- Review webhook delivery logs in the "Advanced" tab of your GitHub App settings.
</Accordion>

Expand All @@ -219,8 +219,8 @@
</Accordion>

<Accordion title="The app installs, but doesn't respond to events.">
- Ensure webhooks are being delivered and acknowledged by our server with response code 200.

Check warning on line 222 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L222

In general, use active voice instead of passive voice ('being delivered').
- Required permissions were granted during installation.

Check warning on line 223 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L223

In general, use active voice instead of passive voice ('were granted').
</Accordion>

<Accordion title="Can I limit which repositories the app accesses?">
Expand All @@ -230,8 +230,8 @@
<Accordion title="How do I update app permissions later?">
- Go to the app settings as a site admin.
- Modify permissions as needed.
- The app will need to be re-approved by organization owners.
- The app needs to be re-approved by organization owners.
- Notify us of any permission changes so we can advise on any additional steps that may be required.

Check warning on line 234 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L234

In general, use active voice instead of passive voice ('be required').
</Accordion>

<Accordion title="Our GHES is behind a corporate firewall, nginx proxy, or similar setup.">
Expand Down
Loading