Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify-mintlify-ac127224.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

The editor exposes two groups of settings:
  • User settings apply only to you and follow your account across deployments.
  • Publishing settings apply to the entire deployment and affect every editor on the team.

​
User settings

User settings are personal. Changes you make only affect your editor and do not change anything for your teammates.

​
Preferences

Control how the editor looks and behaves for you.
  • Navigation structure: How the left sidebar lists your pages.
    • file-tree (default): Shows pages as a file tree that mirrors your repository.
    • docs-nav: Shows pages in the order defined by your docs.json navigation.
  • Fit to full width: When enabled, content expands to fill the full width of the editor instead of using the default reading width. Useful on wide monitors.
  • Open live preview in new tab: When enabled, clicking the live preview button opens the preview in a new browser tab instead of the side panel.

​
AI instructions

Add personal instructions that the editor’s AI features use when generating or editing content for you. Use this to set your preferred tone, vocabulary, or style rules. AI instructions are limited to 20,000 characters.
Keep AI instructions short and specific. For example: “Use sentence case in headings. Avoid the word ‘simply’. Prefer active voice.”

​
Publishing settings

Publishing settings apply to your whole deployment. Anyone with permission to update the deployment can change them, and the values are used for every pull request created from the editor.
  • Commit instructions: Guidance the editor follows when it generates commit messages. Use this to enforce a commit message format like Conventional Commits. Limited to 20,000 characters.
  • PR instructions: Guidance the editor follows when it generates pull request titles and descriptions. Use this to require a specific PR template or checklist. Limited to 20,000 characters.
  • Create draft PR by default: When enabled, the editor opens new pull requests as drafts. Turn this on if your team reviews changes in draft before requesting review.
  • PR merge method: How the editor merges pull requests.
    • merge (default): Creates a merge commit.
    • squash: Combines all commits into one.
    • rebase: Replays commits onto the target branch without a merge commit.
The PR merge method only applies to merges initiated from the editor. Merges performed directly in your Git provider use that provider’s configuration.

​
Example: enforce Conventional Commits

Set commit instructions like the following so the editor formats every commit message consistently:
Commit instructions
Use Conventional Commits format: <type>(<scope>): <subject>.
Types: feat, fix, docs, chore, refactor.
Keep the subject under 70 characters and use the imperative mood.