# Валидация контента

## Разметка

Валидатор отслеживает корректность указания ресурсов и ссылок.

Пример некорректного использования файла ресурса:

```text
![broken image](/resources/load-screen.png).
```

Пример битой ссылки на файл из другого раздела:

```text
[Ссылки](../features/list.md).
```

Пример битой ссылки на подраздел текущего файла:

```text
[Стайлгайд](#стайл-гайд).
```

## Приватная информация

В документации недопустимо демонстрировать e-mail и IP адреса ни в тексте, ни в файлах с примерами кода. Используйте плейсхолдеры `mail@example.com` и `\{ IP_ADDRESS }` вместо `mymail@mail.ru` и `210.210.0.0`.

## Стайлгайд

Если использовать в тексте букву "Ё", в отчете валидации будет рекомендация по ее удалению.

Обращайте внимание на правильность написания общеупотребимых аббревиатур и названий. Например, используйте "MySQL" вместо "mysql", если оно используется в тексте. Если это название параметра, оформляйте его как строчный код (`mysql`), чтобы избежать срабатывания валидатора.

Не используйте в тексте англицизмы и разговорные слова, например, "креды" или "деплой".
