Каркас Знаний

Библиотека знаний Каркас — платформа для разработки Telegram-ботов, модульная CRM-cистема в твоем корпоративном или личном чате.

Разработка

📥 Создание форка репозитория

Для контроля качества и безопасности контента проекта Каркас.Знаний все изменения вносятся в личную копию репозитория (Fork). Процесс создания форка описан в разделе Внесение изменений.

⚙️ Локальный запуск проекта

Перед запуском проекта локально убедитесь, что в вашей операционной системе установлены необходимые для запуска приложения: Git, Node.js, npm. Ниже приведен пример установки приложений для операционной системы «Альт»:

su -
apt-get install node npm git

Клонируем созданную ранее личную копию репозитория:

# Клонирование с использованием доступа к репозиторию по HTTPS
git clone https://gitflic.ru/project/{user}/karkas-wiki.git

# Клонирование с использование доступа к репозиторию по SSH
git clone git@gitflic.ru:{user}/karkas-wiki.git

Теперь на вашем компьютере в папке karkas-wiki, находится полная копия репозитория.

[!NOTE] Замените {user} на ваше имя пользователя на GitFlic. Проще всего его найти в cервисе GitFlic в самом верху страницы репозитория.

Перейдите в папку проекта и для начала работы запустите в режиме разработки (редактирования) склонированный проект Каркас Знания:

cd karkas-wiki
npm i
npm run docs:dev

📝 Внесение изменений

Для вашего удобства, все инструкции по созданию и редактированию статей собраны в разделе «Для авторов».

Участники проекта разработали материалы, которые вы можете найти на странице «Общие правила». Они помогут вам лучше понять, как работает проект, и позволят вам эффективно и просто работать с Каркас.Знаний в роли участника.

Настоятельно рекомендуется проверить ваши коммиты на орфографические и критические ошибки до отправке PR в основную ветку проекта. Для этого ознакомьтесь со страницей «Проверка текста на ошибки»

[!TIP] Следование вышеперечисленному — залог хорошего будущего проекта.

📤 Отправка изменений

Для того, чтобы изменения стали доступны всем, нужно создать Запрос на слияние (Pull Request). Процесс создания описан в разделе Внесение изменений.

Зеркало

Вся документация из репозитория Каркас Знания размещается на cайте wiki.karkas.chat, обновление происходит автоматически, после переноса изменений в основную ветку проекта.

Как помочь проекту Каркас.Знания

Вы можете поддержать проект несколькими способами:

Создать задачу с проблемой или предложением по улучшению (Issue);
Создать запрос на слияние с добавлением/исправлением статьи или функционала проекта Каркас.Знания разработанной на платформе VitePress.