Справочник

Кратко

Используйте этот раздел как отправную точку для справки: указателей API, ключей конфигурации, таблиц совместимости, сведений о поддерживаемом поведении CSS и журналов охвата по всем пакетам.

Карта справочника

Справочник	На какие вопросы отвечает
Матрица поддержки CSS	Какие возможности CSS HTML-конвейер проверяет, декларирует, частично поддерживает или не поддерживает.
Указатель API интеграций	Какую страницу API расширений открыть для каждого фреймворка, отрисовщика, транспорта и инструмента сборки.
Разделы интеграций	Где найти справочник API и конфигурации для конкретного пакета.
Справочник по модулю Core	Страницы API и архитектуры уровня модулей, сформированные из основного репозитория.

Контракт справочной статьи

Каждая статья об API должна отвечать на один и тот же набор вопросов:

Вопрос	Обязательный ответ
Что вызывать?	Полностью квалифицированное имя символа, конечная точка, команда CLI или ключ конфигурации.
Какие входные данные принимаются?	Таблица параметров с типом, признаком обязательности, значением по умолчанию и допустимыми значениями.
Что происходит по умолчанию?	Поведение, когда необязательные входные данные не указаны.
Что возвращается?	Тип возвращаемого значения, тело ответа, выходной файл, поток или побочный эффект.
Что может пойти не так?	Исключение, ошибка проверки, статус HTTP или режим отказа при эксплуатации.
Как использовать это безопасно?	Замечания по безопасности, безопасной работе в воркерах, ограничениям размера, путям, тайм-аутам и обработке секретов.

Политика охвата

Справочные страницы опираются на исходный код. Публичные API документируются по исходному коду пакета, файлам конфигурации, тестам и примерам. Внутренние вспомогательные классы документируются только тогда, когда разработчикам приложений нужно понимать их поведение для настройки или эксплуатации пакета.

Готовность к переводу

На справочных страницах лучше использовать таблицы, а не плотные абзацы. Каждая строка должна быть самодостаточной, потому что при последующей сегментации в формате Extensible Localization Interchange File Format (XLIFF) содержимое будет разделено на блоки.