You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- ✅ **Syntax Checking** - Detects common MDX/JSX syntax errors
27
-
- ✅ **PR Comments** - Automatically comments on PRs with validation results
28
-
29
-
Run `./scripts/validate-docs.sh` to check for errors before committing.
30
-
31
-
## Development
5
+
## Making Changes
32
6
33
7
Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally:
34
8
35
9
```sh
36
10
npm i -g mint
37
11
```
38
12
39
-
Run the following command at the root of your documentation, where your `docs.json` is located:
13
+
Run the following command. It will display a preview of you changes at `http://localhost:3000`.
40
14
41
-
```bash
15
+
```sh
42
16
mint dev
43
17
```
44
18
45
-
View your local preview at `http://localhost:3000`.
46
-
47
-
## Publishing changes
48
-
49
-
Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.
50
-
51
-
**Important:** All PRs must pass validation checks before merging.
52
-
53
19
## Contributing
54
20
55
21
1.**Before committing:**
56
-
- Run `./scripts/validate-docs.sh` to check for errors
57
22
- Test your changes locally with `mint dev`
23
+
- Check for broken links with `mint broken-links`
58
24
- Ensure all links work correctly
59
25
60
26
2.**Creating a PR:**
@@ -67,8 +33,6 @@ Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/sett
67
33
- Review any warnings in PR comments
68
34
- Verify changes render correctly
69
35
70
-
## Need help?
71
-
72
36
### Troubleshooting
73
37
74
38
-**Dev environment not running:** Run `mint update` to ensure you have the most recent version of the CLI
@@ -79,9 +43,5 @@ Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/sett
0 commit comments