Skip to content

Commit 6b8c070

Browse files
authored
Merge pull request #18 from continuedev/nate/docs
move docs to mintlify
2 parents 5d4f408 + 5aa87e8 commit 6b8c070

File tree

15 files changed

+54
-17794
lines changed

15 files changed

+54
-17794
lines changed

.DS_Store

8 KB
Binary file not shown.

docs-main/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
### Development
2+
3+
Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
4+
5+
```
6+
npm i -g mintlify
7+
```
8+
9+
Run the following command at the root of your documentation (where mint.json is)
10+
11+
```
12+
mintlify dev
13+
```
14+
15+
### Publishing Changes
16+
17+
Install our Github App to autopropagate changes from youre 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.
18+
19+
#### Troubleshooting
20+
21+
- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
22+
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`
File renamed without changes.

docs/docs/index.md renamed to docs-main/index.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
---
2-
title: rules CLI
2+
title: Rules CLI
3+
mode: center
34
---
45

5-
# rules
6-
7-
:::tip
6+
<Tip>
87

98
**tl;dr:** `npm i -g rules-cli` then `rules add starter/nextjs-rules`
109

11-
:::
10+
</Tip>
1211

1312
`rules` is a CLI built for managing rules across any AI IDE. Rules are markdown files that encode workflows, preferences, tech stack details, and more in plain natural language so you can get better help from LLMs.
1413

docs-main/mint.json

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"$schema": "https://mintlify.com/schema.json",
3+
"name": "Rules CLI Docs",
4+
"logo": {
5+
"dark": "/favicon.ico",
6+
"light": "/favicon.ico"
7+
},
8+
"favicon": "/favicon.ico",
9+
"colors": {
10+
"primary": "#0D9373",
11+
"light": "#07C983",
12+
"dark": "#0D9373",
13+
"anchors": {
14+
"from": "#0D9373",
15+
"to": "#07C983"
16+
}
17+
},
18+
"topbarLinks": [],
19+
"tabs": [],
20+
"anchors": [],
21+
"footerSocials": {},
22+
"navigation": [
23+
{
24+
"group": "Rules",
25+
"pages": ["index"]
26+
}
27+
]
28+
}

docs/.gitignore

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/README.md

Lines changed: 0 additions & 41 deletions
This file was deleted.

docs/docusaurus.config.ts

Lines changed: 0 additions & 80 deletions
This file was deleted.

0 commit comments

Comments
 (0)