check-hashicorp-style

You can validate HashiCorp documentation by running the /check-hashicorp-style command to detect active voice, present tense, and word-choice compliance issues in your Markdown or MDX content.

The best way to enforce a style guide is to lint documentation during the review phase to catch style regressions and fix formatting, voice, and terminology issues before publication.

Yes, you can automatically fix common style and formatting issues in MDX content using the optional auto-fix capabilities provided by the documentation style linter.

Yes, the HashiCorp style linter works with Markdown and MDX files, validating content against official style rules to ensure consistent terminology and formatting.

Documentation formatting validation checks for active voice, simple present tense, precise word choice, consistent terminology, and formatting rules defined in the official styleguide.md.

You should run a documentation style check during authoring, drafting, or pre-publication reviews to catch and fix style regressions before publishing your content.