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
82 changes: 82 additions & 0 deletions contributing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
---
title: "Contributing"
description: "Learn how to contribute to Mintlify documentation and help improve the developer experience"
icon: "heart"
---

We welcome contributions to Mintlify documentation! Whether you're fixing a typo, improving an explanation, or adding new content, your help makes our documentation better for everyone.

Check warning on line 7 in contributing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contributing.mdx#L7

Try to avoid using first-person plural like 'We'.

Check warning on line 7 in contributing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contributing.mdx#L7

Don't use exclamation points in text.

Check warning on line 7 in contributing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contributing.mdx#L7

Try to avoid using first-person plural like 'our'.

## Ways to contribute

### Report issues

Found a problem with our documentation? Help us fix it:

Check warning on line 13 in contributing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contributing.mdx#L13

Try to avoid using first-person plural like 'our'.

Check warning on line 13 in contributing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contributing.mdx#L13

Try to avoid using first-person plural like 'us'.

- **Broken links**: Report any links that don't work
- **Outdated information**: Let us know if content is no longer accurate

Check warning on line 16 in contributing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contributing.mdx#L16

Try to avoid using first-person plural like 'us'.
- **Missing information**: Suggest topics that need better coverage
- **Unclear explanations**: Point out sections that could be clearer

[Report an issue on GitHub](https://github.com/mintlify/docs/issues/new)

### Suggest improvements

Have ideas for making our documentation better?

Check warning on line 24 in contributing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contributing.mdx#L24

Try to avoid using first-person plural like 'our'.

- **New guides**: Suggest tutorials or guides that would help users
- **Better examples**: Propose more practical or clearer code examples
- **UI improvements**: Share ideas for better navigation or layout
- **Content organization**: Suggest ways to restructure information

[Start a discussion on GitHub](https://github.com/mintlify/docs/discussions)

### Submit changes

Ready to contribute directly? Here's how:

1. **Fork the repository**: Create your own copy of the [docs repository](https://github.com/mintlify/docs)
2. **Make your changes**: Edit the relevant MDX files
3. **Test locally**: Run `mint dev` to preview your changes
4. **Submit a pull request**: Describe your changes and why they're helpful

### Documentation standards

When contributing, please follow these guidelines:

- **Use second-person voice**: Write "you" instead of "the user"
- **Keep headings in sentence case**: "Getting started" not "Getting Started"
- **Include code examples**: Show practical implementations
- **Add alt text to images**: Make content accessible
- **Test all links**: Ensure external links work correctly

## Getting help

Need help with your contribution?

- **Join our community**: Connect with other contributors and maintainers

Check warning on line 56 in contributing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contributing.mdx#L56

Try to avoid using first-person plural like 'our'.
- **Ask questions**: Use GitHub discussions for questions about contributing
- **Review existing issues**: See what others are working on

## Recognition

We appreciate all contributions! Contributors are recognized in:

Check warning on line 62 in contributing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contributing.mdx#L62

Try to avoid using first-person plural like 'We'.

Check warning on line 62 in contributing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contributing.mdx#L62

Don't use exclamation points in text.

Check warning on line 62 in contributing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contributing.mdx#L62

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

- **GitHub contributors list**: Automatic recognition for merged pull requests
- **Release notes**: Major contributions highlighted in updates
- **Community showcases**: Outstanding contributions featured in our community

Check warning on line 66 in contributing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contributing.mdx#L66

Try to avoid using first-person plural like 'our'.

## Code of conduct

We're committed to providing a welcoming and inclusive environment. Please:

Check warning on line 70 in contributing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contributing.mdx#L70

Try to avoid using first-person plural like 'We'.

- **Be respectful**: Treat all community members with kindness
- **Be constructive**: Provide helpful feedback and suggestions
- **Be patient**: Remember that everyone is learning and contributing in their spare time

## License

By contributing to Mintlify documentation, you agree that your contributions will be licensed under the same terms as the project.

Check warning on line 78 in contributing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contributing.mdx#L78

Avoid using 'will'.

Check warning on line 78 in contributing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contributing.mdx#L78

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

---

Thank you for helping make Mintlify documentation better for everyone! 🎉

Check warning on line 82 in contributing.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

contributing.mdx#L82

Don't use exclamation points in text.
4 changes: 2 additions & 2 deletions index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Introduction"
description: "Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers."
description: "Mintlify solves the problem of creating and maintaining developer documentation that's both beautiful and functional, without requiring extensive technical setup."
icon: "book-open"
mode: "custom"
---
Expand All @@ -21,8 +21,8 @@
</h3>
<span className="mt-1.5">{description}</span>
</a>
);

Check warning on line 24 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L24

Use semicolons judiciously.
};

Check warning on line 25 in index.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

index.mdx#L25

Use semicolons judiciously.

<div className="relative">
<div className="absolute top-0 lg:-top-16 left-0 right-0">
Expand All @@ -42,7 +42,7 @@
</h1>

<div className="max-w-xl mx-auto px-4 mt-4 text-lg text-center text-gray-500 dark:text-zinc-500">
Meet the next generation of documentation. AI-native, beautiful out-of-the-box, and built for developers.
Mintlify solves the problem of creating and maintaining developer documentation that's both beautiful and functional, without requiring extensive technical setup.
</div>

<div className="px-6 lg:px-0 mt-12 lg:mt-24 grid sm:grid-cols-2 gap-x-6 gap-y-4">
Expand Down
55 changes: 55 additions & 0 deletions license.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
title: "License"
description: "License information for Mintlify documentation and platform"
icon: "scale-balanced"
---

## Documentation License

Check warning on line 7 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L7

'Documentation License' should use sentence-style capitalization.

The Mintlify documentation is licensed under the [MIT License](https://opensource.org/licenses/MIT).

Check warning on line 9 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L9

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

### MIT License

Check warning on line 11 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L11

'MIT License' should use sentence-style capitalization.

Check warning on line 11 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L11

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

```
MIT License

Copyright (c) 2024 Mintlify

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```

## Platform License

Check warning on line 37 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L37

'Platform License' should use sentence-style capitalization.

The Mintlify platform and CLI tools are proprietary software owned by Mintlify, Inc.

Check warning on line 39 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L39

Use 'command-line tool' instead of 'CLI'.

### Terms of Service

Check warning on line 41 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L41

'Terms of Service' should use sentence-style capitalization.

Use of the Mintlify platform is governed by our [Terms of Service](https://mintlify.com/terms).

Check warning on line 43 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L43

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

Check warning on line 43 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L43

Try to avoid using first-person plural like 'our'.

### Privacy Policy

Check warning on line 45 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L45

'Privacy Policy' should use sentence-style capitalization.

Your privacy is important to us. Please review our [Privacy Policy](https://mintlify.com/privacy) to understand how we collect, use, and protect your information.

Check warning on line 47 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L47

Try to avoid using first-person plural like 'us'.

Check warning on line 47 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L47

Try to avoid using first-person plural like 'our'.

Check warning on line 47 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L47

Try to avoid using first-person plural like 'we'.

## Third-Party Licenses

Check warning on line 49 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L49

'Third-Party Licenses' should use sentence-style capitalization.

Mintlify uses various open-source libraries and tools. For a complete list of third-party licenses, please refer to our [dependency licenses](https://github.com/mintlify/docs/blob/main/LICENSES.md).

Check warning on line 51 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L51

Use 'open source' instead of 'open-source'.

Check warning on line 51 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L51

Try to avoid using first-person plural like 'our'.

## Questions

If you have questions about licensing, please contact us at [[email protected]](mailto:[email protected]).

Check warning on line 55 in license.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

license.mdx#L55

Try to avoid using first-person plural like 'us'.
25 changes: 25 additions & 0 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,33 @@

This quickstart guide shows you how to set up and deploy your documentation site in minutes.

After completing this guide, you will have a live documentation site ready to customize and expand.

Check warning on line 9 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L9

Avoid using 'will'.

## Quick example

Here's a simple example of what you can create with Mintlify:

```mdx hello.mdx
---
title: "My First Page"
description: "Welcome to my documentation"
---

# Hello World

This is my first documentation page with Mintlify!

<Tip>
You can add interactive components like this tip box.
</Tip>

```bash
npm install your-package
```

That's it! Your page is now live and beautiful.

Check warning on line 33 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L33

Don't use exclamation points in text.
```

<Info>

**Prerequisites**: Before you begin, [create an account](https://mintlify.com/start) and complete onboarding.
Expand Down Expand Up @@ -127,7 +152,7 @@
mint dev
```

Your preview will be available at `localhost:3000`.

Check warning on line 155 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L155

Avoid using 'will'.

<Frame>
<img src="/images/quickstart/mintlify-dev-light.png" alt="Mintlify Dev" className="block dark:hidden" />
Expand All @@ -140,7 +165,7 @@

Mintlify automatically detects the changes, builds your documentation, and deploys the updates to your site. Monitor the deployment status in your GitHub repository commit history or the [dashboard](https://dashboard.mintlify.com).

After the deployment completes, your latest update will be available at `<your-project-name>.mintlify.app`.

Check warning on line 168 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L168

Avoid using 'will'.

<Card title="Jump to adding a custom domain" icon="arrow-down" href="#adding-a-custom-domain" horizontal>
Optionally, skip the web editor workflow and jump to adding a custom domain.
Expand All @@ -148,7 +173,7 @@

## Web editor workflow

The web editor workflow provides a what-you-see-is-what-you-get (WYSIWYG) interface for creating and editing documentation. This workflow is best for people who want to work in their web browser without additional local development tools.

Check warning on line 176 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L176

Use parentheses judiciously.

### Access the web editor

Expand All @@ -156,7 +181,7 @@
2. Select **Editor** on the left sidebar.

<Info>
If you have not installed the GitHub App, you will be prompted to install the app when you open the web editor.

Check warning on line 184 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L184

Use 'haven't' instead of 'have not'.

Check warning on line 184 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L184

Avoid using 'will'.

Check warning on line 184 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L184

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

<Frame>
Expand All @@ -166,11 +191,11 @@

### Edit the documentation

In the web editor, you can navigate through your documentation files in the sidebar. Let's update the introduction page:

Check warning on line 194 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L194

Try to avoid using first-person plural like 'Let's'.

Find and select `index.mdx` in the file explorer.

Then, in the editor, update the title field to "Hello World".

Check warning on line 198 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L198

Commas and periods go inside quotation marks.

<Frame>
<img alt="Editing in Web Editor" src="/images/quickstart/web-editor-editing-light.png" className="block dark:hidden" />
Expand All @@ -189,7 +214,7 @@
Use branches to preview and review changes through pull requests before deploying to your live site.
</Tip>

For more details about using the web editor, including using branches and pull requests to collaborate and preview changes, see our [web editor documentation](/editor/getting-started).

Check warning on line 217 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L217

Try to avoid using first-person plural like 'our'.

## Adding a custom domain

Expand All @@ -202,21 +227,21 @@
<img src="/images/quickstart/custom-domain-dark.png" alt="Custom Domain" className="hidden dark:block" />
</Frame>

Enter your domain (for example, `docs.yourcompany.com`) and follow the provided instructions to configure DNS settings with your domain provider.

Check warning on line 230 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L230

Use parentheses judiciously.

<Table>
| Record Type | Name | Value | TTL |
|-------------|------|-------|-----|
| CNAME | docs (or subdomain) | cname.mintlify.app | 3600 |

Check warning on line 235 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L235

Use parentheses judiciously.
</Table>

<Info>
DNS changes can take up to 48 hours to propagate, though changes often complete much sooner.
</Info>

## Next steps

Check warning on line 242 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L242

'Next steps' should use sentence-style capitalization.

Congratulations! You have successfully deployed your documentation site with Mintlify. Here are suggested next steps to enhance your documentation:

Check warning on line 244 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L244

Don't use exclamation points in text.

Check warning on line 244 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L244

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

<Card title="Configure your global settings" icon="settings" href="settings" horizontal>
Configure site-wide styling, navigation, integrations, and more with the `docs.json` file.
Expand Down Expand Up @@ -246,6 +271,6 @@
Deployment can take upwards to a few minutes. Check your GitHub Actions (for code-based workflow) or deployment logs in the Mintlify dashboard to ensure there are no build errors.
</Accordion>
<Accordion title="Custom domain not connecting">
Verify that your DNS records are set up correctly and allow sufficient time for DNS propagation (up to 48 hours). You can use tools like [DNSChecker](https://dnschecker.org) to verify your CNAME record.

Check warning on line 274 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L274

In general, use active voice instead of passive voice ('are set').
</Accordion>
</AccordionGroup>
Loading