Skip to content

Commit ae8b863

Browse files
committed
Update settings
1 parent 195e2c7 commit ae8b863

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

core-concepts/settings.mdx

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,17 @@ description: "Configure the global settings for your documentation"
44
icon: "settings-2"
55
---
66

7-
<Card title="The docs.json file" href="#customization" icon="file-code-2" horizontal>
7+
<Card title="The docs.json file" href="#reference" icon="file-code-2" horizontal>
88
Skip to the reference
99
</Card>
1010

11-
Every documentation site requires a **docs.json** file. This file contains the global configuration settings and controls everything from styling and navigation to integrations.
11+
Every documentation site requires a **docs.json** file.
1212

13-
<Info>
14-
This file should live at the root of your repository.
15-
</Info>
13+
This file contains the global configuration settings and controls everything from styling and navigation to integrations.
14+
15+
## Reference
16+
17+
This section contains the full reference for the docs.json file.
1618

1719
### Customization
1820

@@ -768,12 +770,14 @@ Every documentation site requires a **docs.json** file. This file contains the g
768770
</Expandable>
769771
</ResponseField>
770772

773+
771774
## Validation
772775

773-
The `docs.json` file is validated against a JSON schema to ensure proper configuration. You can reference the schema by including:
776+
It is advised to include the following schema reference at the top of your docs.json file to ensure proper validation while editing:
774777

775778
```json
776779
{
777-
"$schema": "https://mintlify.com/docs.json"
780+
"$schema": "https://mintlify.com/docs.json",
781+
...
778782
}
779783
```

0 commit comments

Comments
 (0)