Skip to content

development.mdx

Latest commit

 

History

History
106 lines (73 loc) · 2.47 KB

development.mdx

File metadata and controls

106 lines (73 loc) · 2.47 KB
title Contributing to Docs
description Preview and contribute to Alter documentation locally
**Prerequisites**: - Node.js version 19 or higher - Git

Follow these steps to preview the Alter documentation locally and contribute changes.

git clone https://github.com/wearedevx/alter-docs.git
cd alter-docs/docs
npm i -g mint

Run the following command in the docs directory:

mint dev

A local preview of the documentation will be available at http://localhost:3000.

Custom ports

By default, Mintlify uses port 3000. You can customize the port using the --port flag:

mint dev --port 3333

Validating links

Check for broken links before submitting changes:

mint broken-links

AI-Assisted Writing

Set up your AI coding tool to work with Mintlify:

npx skills add https://mintlify.com/docs

This installs Mintlify's documentation skill for AI tools like Claude Code, Cursor, and Windsurf.

Deployment

Changes are deployed automatically when merged to the main branch via GitHub integration.

Screenshot of a deployment confirmation message that says All checks have passed.

Contributing Guidelines

Before contributing, please read:

Key points:

  • Use MDX format with YAML frontmatter
  • Follow the existing content structure
  • Use local /images/ paths for assets
  • Run mint broken-links before submitting

Troubleshooting

This may be due to an outdated version of node. Try the following:
1. Remove the currently-installed version of the CLI: `npm remove -g mint`
2. Upgrade to Node v19 or higher.
3. Reinstall the CLI: `npm i -g mint`

Solution: Go to the root of your device and delete the `~/.mintlify` folder. Then run `mint dev` again.

Curious about what changed in the latest CLI version? Check out the CLI changelog.