Skip to content
Closed
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
14 changes: 12 additions & 2 deletions deploy/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
If you skipped connecting your own Git repository during onboarding, your documentation lives in a private repository owned by the Mintlify organization. To move it to your own account or organization:

1. Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard.
2. Click **Clone as Private** or **Clone as Public**. Public repos allow anyone to view your documentation source and submit issues or suggestions. Private repos restrict access to your team.

Check warning on line 25 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L25

Did you really mean 'repos'?
3. Install the GitHub App by following the steps in [Install the GitHub App](#install-the-github-app) below.

### Alternative: Download and create your own repository
Expand All @@ -36,7 +36,7 @@
5. Return to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) and connect your new repository to Mintlify.
6. Install the GitHub App by following the steps in [Install the GitHub App](#install-the-github-app) below.

## Install the GitHub App

Check warning on line 39 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L39

'Install the GitHub App' should use sentence-style capitalization.

<Note>
You must have organization ownership or administrator permissions in a repository to install the app. If you lack the necessary permissions, the repository owner must approve the installation request.
Expand Down Expand Up @@ -83,9 +83,9 @@

Change the organization, repository, or branch that your documentation builds from in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) section of your dashboard.

## GitHub Enterprise with IP allowlists

Check warning on line 86 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L86

Did you really mean 'allowlists'?

If your GitHub Enterprise Cloud organization has an IP allowlist enabled, you need to add Mintlify's egress IP address (`54.242.90.151`) to your allowlist for the GitHub App to function properly.

Check warning on line 88 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L88

Use 'Google Cloud Platform' or 'GCP' instead of 'Cloud'.

Follow [GitHub's documentation](https://docs.github.com/en/enterprise-cloud@latest/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-allowed-ip-addresses-for-your-organization) to configure your IP allowlist.

Expand All @@ -110,7 +110,7 @@
</Accordion>
</AccordionGroup>

### GitHub App connection issues

Check warning on line 113 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L113

'GitHub App connection issues' should use sentence-style capitalization.

If you encounter problems with the GitHub app, resetting the connection can solve most problems.

Expand All @@ -127,7 +127,13 @@

### Feedback add-ons are unavailable

If you cannot enable the edit suggestions or raise issues options in your dashboard and your repository is public, revalidate your Git settings.
The **edit suggestions** and **raise issues** feedback features are only available for public GitHub repositories. These features are automatically disabled for private repositories to protect your source code and internal documentation structure.

Check warning on line 130 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L130

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

<Warning>
If your repository is private, you cannot enable edit suggestions or raise issues. This is a security feature, not a configuration issue. Making your repository public will automatically enable these options.

Check warning on line 133 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L133

Avoid using 'will'.
</Warning>

If your repository is public but you still cannot enable these options, revalidate your Git settings:

<Steps>
<Step title="Navigate to Git Settings">
Expand All @@ -150,4 +156,8 @@
/>
</Frame>
</Step>
</Steps>
</Steps>

<Note>
When a repository changes from public to private, edit suggestions and raise issues are automatically disabled across all deployments, including preview deployments.

Check warning on line 162 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L162

Use 'turn off' or 'off' instead of 'disabled'.
</Note>
6 changes: 6 additions & 0 deletions optimize/feedback.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,15 @@
- **Thumbs rating**: Simple thumbs up/down voting to gauge overall satisfaction with pages.
- **Contextual feedback**: Free form feedback about the content of a page.
- **Code snippet feedback**: Feedback specifically on code snippets.
- **Edit suggestions**: Allow users to suggest edits to your documentation directly through GitHub. Only available for public GitHub repositories.
- **Raise issues**: Allow users to create GitHub issues to report problems or request improvements. Only available for public GitHub repositories.

<Warning>
**Edit suggestions** and **raise issues** features are only available for public GitHub repositories. These features are automatically disabled when your repository is private to protect your source code and internal documentation structure.

Check warning on line 58 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L58

Use 'turn off' or 'off' instead of 'disabled'.
</Warning>

<Note>
If you disable telemetry in your `docs.json` file, feedback features are not available on your documentation pages.

Check warning on line 62 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L62

Use 'turn off' or 'off' instead of 'disable'.
</Note>

## Manage feedback
Expand All @@ -67,13 +73,13 @@
Best practices for setting feedback statuses:

- **Pending**: Feedback is awaiting review.
- **In Progress**: Feedback has been validated and is being worked on.

Check warning on line 76 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L76

In general, use active voice instead of passive voice ('been validated').

Check warning on line 76 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L76

In general, use active voice instead of passive voice ('being worked').
- **Resolved**: Feedback has been resolved.

Check warning on line 77 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L77

In general, use active voice instead of passive voice ('been resolved').
- **Dismissed**: Feedback has been dismissed as not actionable, irrelevant, or inaccurate.

Check warning on line 78 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L78

In general, use active voice instead of passive voice ('been dismissed').

### Filter by status

Use the status filter to control which feedback is displayed. Clear a status to hide all feedback with that status. By default, all feedback is displayed.

Check warning on line 82 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L82

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

Check warning on line 82 in optimize/feedback.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

optimize/feedback.mdx#L82

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

### Add internal notes

Expand Down