Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 1.84 KB

development.mdx

File metadata and controls

64 lines (41 loc) · 1.84 KB
Raw
title description
Development Guide
Guidelines and instructions for developing on the AI Platform

Development Setup

Please note that each CLI release is associated with a specific version of Mintlify. If your local website doesn't align with the production version, please update the CLI:

npm i -g mintlify@latest
yarn global upgrade mintlify

Validating Links

The CLI can assist with validating reference links made in your documentation. To identify any broken links, use the following command:

mintlify broken-links

Deployment

Unlimited editors available under the [Pro Plan](https://mintlify.com/pricing) and above.

If the deployment is successful, you should see the following:

Code Formatting

We suggest using extensions on your IDE to recognize and format MDX. If you're a VSCode user, consider the MDX VSCode extension for syntax highlighting, and Prettier for code formatting.

Troubleshooting

Common Issues

  • Mintlify CLI Not Updating:

    • Solution: Ensure you have the latest version by running npm i -g mintlify@latest or yarn global upgrade mintlify.

  • Broken Links Detected:

    • Solution: Run mintlify broken-links to identify and fix broken links in your documentation.

  • Deployment Fails:

    • Solution: Check the deployment logs for errors. Ensure all environment variables are correctly set and that you have the necessary permissions.

Additional Resources