Skip to content

README.md

Latest commit

 

History

History
55 lines (34 loc) · 1.56 KB

README.md

File metadata and controls

55 lines (34 loc) · 1.56 KB
Raw

Numo docs

This repository contains the Mintlify documentation site for Numo.

The docs site includes:

  • Guide pages
  • Navigation
  • Site configuration
  • API reference pages
  • Reusable Mintlify components

Use this repository as the source for documentation content and deployment changes.

AI-assisted writing

Set up your AI coding tool with Mintlify documentation knowledge:

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

This command installs Mintlify's documentation skill for your configured AI tools. The skill includes component reference, writing standards, and workflow guidance.

See the AI tools guides for tool-specific setup.

Development

Install the Mintlify CLI to preview your documentation changes locally. To install, use the following command:

npm i -g mint

Run the following command at the root of your documentation, where your docs.json is located:

mint dev

View your local preview at http://localhost:3000.

Publishing changes

Install the Mintlify GitHub app from your dashboard to propagate changes from this repository to production. Changes deploy automatically after you push to the default branch.

Need help?

Troubleshooting

  • If your dev environment isn't running: Run mint update to 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.

Resources