mirror of https://github.com/mintlify/docs.git synced 2026-09-14 13:35:46 +08:00

Files

T

History

Ethan Palm 29aba2f38b Add headless guide (#3514 )

* Add custom frontend use case guide

Documents the @mintlify/astro integration for building custom
documentation frontends. Covers setup from the starter repo,
how the integration works, and connecting search/assistant.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* Fix Vale errors and broken link in custom frontend guide

Add Astro to Vale vocabulary, fix em dash spacing, and remove
broken /ai/search link.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* Add custom frontend link to guides index

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* Fix Node.js version requirement to v20.17.0+

Matches the Mintlify CLI minimum requirement.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* create custom frontend guide

* Rewrite setup steps to match actual onboarding flow

* copyedit

* reviewer feedback

* add image of repo settings

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>

2026-02-18 08:10:02 -08:00

scripts

Update Vale configuration (#1194 )

2025-09-19 10:05:27 -07:00

styles

Add headless guide (#3514 )

2026-02-18 08:10:02 -08:00

README.md

Vale 🧹 (#3410 )

2026-02-11 17:44:33 -08:00

README.md

Vale Configuration for Mintlify Docs

This directory contains the Vale linting configuration for Mintlify documentation.

Philosophy

Start simple and grow incrementally as needs emerge.

Vale files

.vale.ini - Main configuration file
styles/config/vocabularies/Mintlify/ - Mintlify-specific terms
styles/Mintlify/ - Style rules derived from the Google developer documentation style and customized for Mintlify

When to add vocabulary

Mintlify terms - New components, features, platform-specific concepts
Frequent false positives - Any terms that repeatedly trigger errors, but shouldn't

Discover new vocabulary

Use the included script to find vocabulary candidates:

# Discover terms from all files
.vale/scripts/discover-vocabulary.sh

# Discover from specific files
.vale/scripts/discover-vocabulary.sh "components/*.mdx"

This script:

Runs Vale on specified files
Extracts spelling error suggestions
Saves results to .vale/vocabulary-candidates.txt

When to add new rules

Consistent patterns - The same style issue appears frequently
High-value, low-noise - Rules that catch problems with minimal false positives

Testing new rules

Before adding a new rule:

Test locally: vale path/to/file.mdx
Run on sample files: vale components/*.mdx
Check false positive rate
Start with level: suggestion then promote to warning or error