Skip to content

Conversation

@sg-writer
Copy link
Contributor

@sg-writer sg-writer commented Oct 29, 2025

This PR:

  • Adds a custom word list of accepted terms
  • Removes some rejected terms from the Google word list
  • Addresses all errors related to the word lists

We should be able to safely turn Vale CI checks back on in the Mintlify dashboard after this PR is merged. There might be some unnecessary noise from warnings and suggestions at first but we can continue to iterate on them to make them useful.

@sg-writer sg-writer added kind/enhancement New feature or improvement to the docs experience docs/infra Changes to the infrastructure of the docs site labels Oct 29, 2025
@sg-writer sg-writer force-pushed the sg/doc-448-create-vale-word-list-covering-all-ngrokisms branch from f4989ff to ebde684 Compare October 31, 2025 17:15
Copy link
Collaborator

@S3Prototype S3Prototype left a comment

Choose a reason for hiding this comment

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

Approved to unblock! Should definitely whitelist generated files though, and codeblocks if possible

});

// Output ngrok url to console
// Output ngrok URL to console
Copy link
Collaborator

Choose a reason for hiding this comment

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

As a passing question, is there any way to make this ignore code snippets? In this case, it's a good change, but I think it'd be weird if you got a vale error for a variable name

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I do need to look into how to fine-tune it that way - I had to remove a rule enforcing lowercase "ngrok" because sometimes it appears in the code as NgrokFooBar 🙃


<Note>
Ensure your chosen domain has the proper TLS/SSL certs provisioned in order to create a secure, working connection.
Ensure your chosen domain has the proper TLS/SSL certs provisioned to create a secure, working connection.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice. "in order to" is the bane of my existence

Copy link
Contributor Author

Choose a reason for hiding this comment

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

once we turn Vale back on in the dashboard "in order to" should fail the CI check and force you to delete it before merging 😈

@sg-writer sg-writer merged commit 33b08fa into main Nov 4, 2025
3 checks passed
@sg-writer sg-writer deleted the sg/doc-448-create-vale-word-list-covering-all-ngrokisms branch November 4, 2025 16:40
Copy link
Contributor

Choose a reason for hiding this comment

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

This file is generated so the main repo is going to put this back.

Copy link
Contributor

Choose a reason for hiding this comment

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

This file is generated so the main repo is going to put this back.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs/infra Changes to the infrastructure of the docs site kind/enhancement New feature or improvement to the docs experience

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants