Skip to content
Closed
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
10 changes: 9 additions & 1 deletion deploy/docs-subpath.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,22 @@
Setting up a `/docs` subpath varies depending on your hosting provider. Choose your hosting provider and follow the setup instructions.

- [Cloudflare](/deploy/cloudflare): Set up Cloudflare Workers for your domain to serve your documentation at the `/docs` subpath.
- [AWS Route 53 and CloudFront](/deploy/route53-cloudfront): Deploy your documentation at the `/docs` subpath using AWS with Route 53 DNS and CloudFront CDN.

Check warning on line 14 in deploy/docs-subpath.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/docs-subpath.mdx#L14

Spell out 'CDN', if it's unfamiliar to the audience.
- [Vercel](/deploy/vercel#host-from-docs) - Use rewrites to deploy your documentation at the `/docs` subpath.
- [Custom reverse proxy](/deploy/reverse-proxy) - For other hosting platforms, set up a reverse proxy to deploy your documentation at the `/docs` subpath.

### Additional configuration for strict security policies

If you proxy all traffic on your custom domain, you may need to configure [headers](/deploy/csp-configuration) added by your proxy or firewalls to ensure that your documentation is served correctly.

Check warning on line 20 in deploy/docs-subpath.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/docs-subpath.mdx#L20

Use 'firewall rules' instead of 'firewalls'.

Check warning on line 20 in deploy/docs-subpath.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/docs-subpath.mdx#L20

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

## Custom subpaths

If you need your documentation at a subpath other than `/docs` (for example, `/help` or `/guides`), contact the [Mintlify team](mailto:support@mintlify.com) with details about your desired path and hosting setup.
You can host your documentation at any custom subpath (for example, `/help` or `/guides`) by setting the `basePath` configuration in your `docs.json` file:

```json docs.json
{
"basePath": "/help"
}
```

After configuring your `basePath`, follow the setup instructions for your hosting provider above to route traffic to your documentation at the custom subpath.

Check warning on line 32 in deploy/docs-subpath.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/docs-subpath.mdx#L32

Use 'preceding' instead of 'above'.