Chiori docs

Пользовательская документация по Шиори.

Добро пожаловать в документацию для Chiori! Здесь вы сможете подробнее узнать про сам проект. Как пользоваться ботом и какие есть особенности. Как начать писать свои собственные расширения и использовать Chiori API. И поближе познакомиться с внутренним устройством ядра.

Актуальная документация доступна здесь: chio.miroq.ru.

Документация написана с использованием Starlight. Это позволяет собирать очень красивый сайт на основа MarkDowm файлов документации.

Содержание

Документация поделена на следующие разделы. Содержание страниц со временем может измениться.

• chiori: Подробности про внутренне устройство Шиори.

• dev: Раздел для разработчиков ядра. Здесь рассказывается подробнее про настройки. Каким образом можно внести вклад в развитие проекта. Как установить и запустить локальную сборку Шиори. Какие есть библиотеки во встроенной коллекции. Структура проекта.

• guides: Раздел обучения как писать расширения. Как добавлять настройки в расширения. Как хранить долгосрочную информацию в базе данных. Как создавать и использовать собственные события. Когда стоит выделать функционал в библиотеки. Как написать своё первое расширение. С чего вообще начать как разработчику. Как использовать систему тегов.

• release: Подробности в новых версиях Шиори. Недавно вышедшее обновление v0.12.0.

• use: Раздел для пользователей Шиори. Что такое команды бота и как их использовать. Что такое событие. Когда команды объединяются в расширения. Какие возможности есть в Шиори. Когда набор расширений и библиотек становится сборкой. Список версий Шиори.

Сборка документации

Если вы хотите помочь в разработке документации. Вот вам краткая инструкция как собрать её локально.

1. Клонируем репозиторий с документацией.

git clone https://git.miroq.ru/chio/docs
cd docs

2. Устанавливаем зависимости при помощи Bun.

bun i

3. Запускаем тестовый сервер для отладки.

bun dev

4. После внесения изменений форматируем файлы под единый стиль.

bun format

5. Проверяем что сайт успешно собирается, выполним локальную сборке.

bun run build

Вот и всё, документация была собрана в каталог dist/.

Поддержка

Если вам понравился проект, мы будем очень рады если вы внесёте свой вклад в его развитие. Сделать это вы можете следующими способами:

• Расскажете о проекте своим друзьям.
• Оставите обратную связь на Discord сервере.
• Станете частью команды по написанию документации.

Давайте вместе сделаем документацию Шиории чуточку лучше.