This is the official documentation for Alter, a macOS AI assistant that lets you create custom Actions to automate tasks and integrate with your apps.
This documentation site is built on Mintlify. It contains:
- Getting started guides
- Action creation tutorials
- Custom Action reference
- How-to guides
- Common issues and troubleshooting
Contributors are very welcome. Community additions are encouraged as long as content is accurate, practical, and easy to verify.
AI-assisted writing is welcome, but it must be fact-checked and edited for clarity. Please avoid low-signal AI slop: submissions should be concise, digestible, and genuinely useful for the community. If you are contributing with an AI agent, use ALTER.md as the guideline source of truth before making changes.
Use Conventional Commits for all commit messages.
Examples:
docs(guides): add url callbacks guidechore(ci): validate assets-doc mapping on pull requestsfix(references): correct pricing faq fair-use wording
Install the Mintlify CLI to preview your documentation changes locally:
npm i -g mintRun the following command at the root of your documentation, where your docs.json is located:
mint devView your local preview at http://localhost:3000.
- If your dev environment isn't running: Run
mint updateto ensure you have the most recent version of the CLI. - If a page loads as a 404: Make sure you are running in a folder with a valid
docs.json. - Check for broken links: Run
mint broken-links