Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented Jan 15, 2026

Documentation changes

See title. Works locally

Closes


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Adopts native MDX parsing in Vale to simplify and improve MDX linting.

  • Add MDX to Packages and use mdx2vast for *.mdx
  • Remove legacy formats, MDX-specific TokenIgnores/BlockIgnores, and CommentDelimiters
  • Retain existing style overrides for changelog.mdx and locale folders (es, fr, zh)

Written by Cursor Bugbot for commit 95e785d. This will update automatically on new commits. Configure here.

Co-authored-by: tembo[bot] <208362400+tembo[bot]@users.noreply.github.com>
SkippedScopes = script, style, pre, figure, code

Packages = Google
Packages = Google, MDX
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MDX package added but not used in BasedOnStyles

Low Severity

The MDX package is added to the Packages directive but is not included in any BasedOnStyles configuration. In Vale, packages listed in Packages are downloaded via vale sync, but their style rules are only applied when referenced in BasedOnStyles. The [*.mdx] section specifies BasedOnStyles = Vale, Google without MDX, so if MDX is a valid style package, its rules would be downloaded but never applied to any files.

Additional Locations (1)

Fix in Cursor Fix in Web

@ethanpalm ethanpalm closed this Jan 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants