Как править документацию

Этот сайт собирается из обычных текстовых файлов в формате Markdown. Программировать не нужно.

Исправить существующую страницу

1. Внизу любой страницы нажмите «Править эту страницу» - откроется редактор GitHub (нужен доступ к репозиторию).
2. Измените текст.
3. Нажмите Commit changes → выберите «Create a new branch and start a pull request» → Propose changes → Create pull request.
4. После слияния запроса в ветку dev сайт обновится сам через минуту-две.

Добавить новую страницу

1. В папке docs-site (или её подпапке, например docs-site/guides) создайте файл с расширением .md, например docs-site/guides/alerts.md. Имя файла - латиницей, без пробелов: оно станет адресом страницы (docs.selltix.io/guides/alerts).
2. Первой строкой напишите заголовок: # Название страницы.
3. Чтобы страница появилась в меню слева, добавьте строку в файл docs-site/.vitepress/config.ts в нужный раздел: { text: 'Название в меню', link: '/guides/alerts' },

Шпаргалка по оформлению

Что нужно	Как написать
Заголовок раздела	## Заголовок
Жирный текст	**текст**
Список	строки, начинающиеся с -
Нумерованный список	строки, начинающиеся с 1.
Ссылка	[текст](https://адрес)
Ссылка на другую страницу	[текст](/guides/keys)
Картинка	положите файл в docs-site/public/, затем 

Заметки в рамке:

::: tip Совет
Текст совета.
:::

::: warning Внимание
Текст предупреждения.
:::

Сайт публичный

Всё, что лежит в папке docs-site, видно всем в интернете. Внутренние заметки, ключи, имена клиентов и название компании сюда не кладите.

Английская версия

Английские страницы лежат в папке docs-site/en с теми же именами файлов. Если страницы нет на английском, в английском меню её просто не будет.