# dev-docs-writing-style

**Repository Path**: mirrors_mulesoft/dev-docs-writing-style

## Basic Information

- **Project Name**: dev-docs-writing-style
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-07-21
- **Last Updated**: 2025-07-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

= MuleSoft Developer Documentations Writing Style

This repository contains a https://github.com/errata-ai/vale[Vale-compatible] implementation of the MuleSoft Writing Style Guide, which is loosely based on the https://docs.microsoft.com/en-us/style-guide/welcome/[Microsoft Writing Style Guide^]. 
link:LICENSE[LICENSE]

The primary purpose of this repository is to enforce the writing style of the https://docs.mulesoft.com[MuleSoft Technical Documentation^]. It contains the style rules in the form of a series of yaml files, which are used by Vale to automatically lint the documentation content via Github actions.

## Getting Started

### Onboarding Local Vale Runs (For Salesforce Employees Only)

See https://confluence.internal.salesforce.com/pages/viewpage.action?spaceKey=MTDT&title=Set+Up+Your+Build+Environment#SetUpYourBuildEnvironment-DownloadOnboardingScript[The Download Onboarding Script section]

## Test

Run `make test` to test the rules against the files in the *test-files/* directory. Run `make test-debug` to see the vale output.

Another way to test is to copy and compile your rule in https://studio.vale.sh/[Vale Studio], and then run it against your test cases.

### How to Test New Rules

If you have created a new rule, please add an adoc file full of test phrases with the same name in *test-files/*. Then add an entry for it in link:test-files/violation-count-map.yaml[violation-count-map.yaml].

== Resources

* https://confluence.internal.salesforce.com/display/MTDT/MuleSoft+CX+Writing+Style+Reference[MuleSoft Writing Style Guide (internal resource. VPN required)]
* https://github.com/errata-ai[errata-ai's repo. Good for referencing rules from other styles]
* https://vale.sh/[vale documentation]
* https://studio.vale.sh/[Vale Studio. Good for testing rules in a web browser]