Правила оформления документации в GitHub Wiki - ixray-team/ixray-1.6-stcop GitHub Wiki
Недопустимые символы в название статьи: ?
, *
, <
, >
, `:
# Название страницы
> [!IMPORTANT]
> **Статус**: [Поддерживается/Устарело/В разработке]
> **Минимальная версия**: [Версия продукта]
> **Последнее обновление**: [YYYY-MM-DD]
Краткое описание функционала/возможности:
## Обзор
[1-3 абзаца с объяснением ключевой концепции]
[Пример использования в одном предложении]
## Синтаксис
[Четкое описание формата]
[Минимальный рабочий пример]
Писать при наличии
[код примера]
→ [Пояснение результата]
[код примера]
→ [Пояснение результата]
- ✔ Правильное использование:
[Советы по применению] - ⚠ Ограничения:
[Потенциальные проблемы и их решения] - ✖ Анти-паттерны:
[Типичные ошибки]
- Используйте блоки кода с указанием языка:
#include "file.ltx"
- Для inline-кода:
`внутри строки`
- Важные заметки:
> [!NOTE] > Пояснительный текст
- Предупреждения:
> [!WARNING] > Текст предупреждения
- Внутри Wiki:
[текст ссылки](Имя-страницы)
- На внешние ресурсы:
[текст](https://example.com)

- Проверьте работоспособность всех примеров кода
- Убедитесь, что ссылки ведут на актуальные страницы
- Проверьте грамматику и читаемость текста