Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
clauderic authored Oct 20, 2024
1 parent 0676276 commit ea50503
Showing 1 changed file with 5 additions and 13 deletions.
18 changes: 5 additions & 13 deletions apps/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,23 @@
# Mintlify Starter Kit
# Documentation

Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including
## Contributing to the @dnd-kit documentation

- Guide pages
- Navigation
- Customizations
- API Reference pages
- Use of popular components
Contributions are welcome to improve the @dnd-kit documentation. Open a [Pull request](https://github.com/clauderic/dnd-kit/pulls) and add the `Documentation` label.

### Development
## Development

Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command

```
npm i -g mintlify
```

Run the following command at the root of your documentation (where mint.json is)
Run the following command at the root of the `/apps/docs` directory:

```
mintlify dev
```

### Publishing Changes

Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.

#### Troubleshooting

- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
Expand Down

0 comments on commit ea50503

Please sign in to comment.