📑 Contributing to Documentation

Спасибо за желание помочь улучшить документацию JXCT! Ниже — краткие правила и чек-лист для pull-request.

---

1. Форматирование

* Markdown (CommonMark) — расширения GitHub поддерживаются. * Файлы UTF-8 без BOM. * Заголовок H1 = emoji + тема + версия/дата (# 📚 API Reference v2.7). * Коды: тройные бэктики с указанием языка (cpp, bash, `json). * Диаграммы — Mermaid ( mermaid`).

2. Линтеры

CI автоматически запускает: 1. markdownlint — стиль. 2. markdown-link-check — работа ссылок.

Запустите локально перед PR: `bash npm i -g markdownlint-cli markdown-link-check markdownlint "/*.md" markdown-link-check README.md `

3. Файловая структура

` docs/ |-- manuals/ # Руководства пользователя |-- dev/ # Технические документы (арх, планы) |-- examples/ # Примеры конфигов / CSV |-- archive/ # Исторические материалы (>1 года) `

4. Язык

* Пользовательские инструкции — 🇷🇺 Русский. * Разработческие (dev/) — 🇬🇧 Английский.

5. Pull-request чек-лист

• [ ] Локально прошёл markdownlint и link-check.

[ ] Добавлен/обновлён TOC при необходимости.

• [ ] Обновлены ссылки, если файл переименован.

[ ] README/Содержание обновлены при добавлении новых важных docs.

Спасибо за вклад!