An open API service indexing awesome lists of open source software.

https://github.com/chainpatrol/docs

πŸ“š Documentation site for ChainPatrol
https://github.com/chainpatrol/docs

documentation

Last synced: about 1 year ago
JSON representation

πŸ“š Documentation site for ChainPatrol

Awesome Lists containing this project

README

          

# ChainPatrol Docs

This repo contains documentation setup for ChainPatrol, currently available atΒ [chainpatrol.mintlify.app](https://chainpatrol.mintlify.app)

### πŸš€ Setup

Simply merge in this PR and your documentation will be connected!

### πŸ‘©β€πŸ’» 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 mintlify -g
```

Run the following command at the root of your documentation (where mint.json is)

```
mintlify dev
```

### 😎 Publishing Changes

Changes will be deployed to production automatically after pushing to the default branch.

You can also preview changes using PRs, which generates a preview link of the docs.

#### Troubleshooting

- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
- Mintlify dev is updating really slowly - Run `mintlify clear` to clear the cache.