Skip to content

Commit a36bccc

Browse files
committed
Update settings page
1 parent 50dcf00 commit a36bccc

File tree

1 file changed

+1
-13
lines changed

1 file changed

+1
-13
lines changed

core-concepts/settings.mdx

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

7-
## Configuration Reference
7+
## `docs.json`
88

99
Every documentation site requires a `docs.json` file that contains the core configuration settings.
1010

@@ -764,18 +764,6 @@ This file controls everything from styling and navigation to integrations.
764764
</Expandable>
765765
</ResponseField>
766766

767-
## Best Practices
768-
769-
When configuring your `docs.json` file, consider these best practices:
770-
771-
1. Keep the configuration organized by grouping related settings together
772-
2. Use meaningful names for groups and pages in your navigation structure
773-
3. Provide complete paths for all assets (logos, favicons, etc.)
774-
4. Test your configuration in both light and dark modes
775-
5. Verify all external links and integrations are correctly configured
776-
6. Use appropriate color contrasts for accessibility
777-
7. Configure SEO settings for better search engine visibility
778-
779767
## Validation
780768

781769
The `docs.json` file is validated against a JSON schema to ensure proper configuration. You can reference the schema by including:

0 commit comments

Comments
 (0)