Skip to content

Mintlify

Mintlify hosts help pages and developer references from documentation files kept in Git.

Visit Mintlify

How does a change go from a draft to the reader site?

Edit pages in the browser or in the connected repository, the folder that records file history. Keep a change in a branch, which is a separate line of edits, until it is ready to publish. The web editor commits edits to Git. Check the branch you are publishing from before confirming.

What can a small team host on Starter?

Mintlify lists free Starter with five editor seats, hosted docs, search, a custom domain and a web editor. Pro adds hosted preview deployments and the Assistant. Hosted preview links are public by default. Mintlify lists organization sign-in and password protection for previews on Enterprise. Before creating a preview of a private draft, confirm it will require access. If you cannot verify that, review it locally.

Do ordinary help pages need an API description?

Write onboarding pages without an API specification. If developers need a reference for the actions your app exposes, provide an OpenAPI file. Mintlify can generate an interactive reference. The playground needs a server address to send requests, so keep any sample pointed only at a dedicated test service.

What would you keep if you moved the help site?

Keep the Markdown or MDX files and the repository history. MDX adds reusable elements to ordinary Markdown. The text can move, while navigation and vendor-specific elements may need adjustments in the next tool.

How would you release help for a renamed button?

Sketch this using fictional text and attachments. Keep the exercise on paper without connecting a workspace or publishing a page.

  1. Write the new step
    Use a fictional app that changes Reserve to Request a seat. Write the reader instruction.
  2. Mark when it can go live
    Put the help update beside the product change and name the person who checks that the new button is available.
  3. Keep the portable text
    Draw the page file and its image reference. Mark any custom element you would rebuild if the site moves.