diff --git a/documentation/docs/assets/favicon.ico b/documentation/docs/assets/favicon.ico deleted file mode 100644 index 032718b..0000000 Binary files a/documentation/docs/assets/favicon.ico and /dev/null differ diff --git a/documentation/docs/blog/index.md b/documentation/docs/blog/index.md deleted file mode 100644 index f5adf54..0000000 --- a/documentation/docs/blog/index.md +++ /dev/null @@ -1,10 +0,0 @@ -# Hello Mutiny! - -Once you made Mutiny available to your classpath, you can start writing code. -Let's start with this simple program: - -## Test - -### Test 2 - -## Test 3 \ No newline at end of file diff --git a/documentation/docs/changelog.md b/documentation/docs/changelog.md new file mode 100644 index 0000000..f6b2c70 --- /dev/null +++ b/documentation/docs/changelog.md @@ -0,0 +1,6 @@ +--- +hide: +- comments +title: ChangeLog + +--- \ No newline at end of file diff --git a/documentation/docs/getting-started/index.md b/documentation/docs/getting-started/index.md deleted file mode 100644 index f5adf54..0000000 --- a/documentation/docs/getting-started/index.md +++ /dev/null @@ -1,10 +0,0 @@ -# Hello Mutiny! - -Once you made Mutiny available to your classpath, you can start writing code. -Let's start with this simple program: - -## Test - -### Test 2 - -## Test 3 \ No newline at end of file diff --git a/documentation/docs/getting-started/installing-dependencies.md b/documentation/docs/getting-started/installing-dependencies.md deleted file mode 100644 index 535fdeb..0000000 --- a/documentation/docs/getting-started/installing-dependencies.md +++ /dev/null @@ -1,122 +0,0 @@ ---- -hide: -- toc ---- -# Варианты добавления в проект -Есть несколько вариантов добавить фреймворк в проект. Изучите их все и выберете подходящий под ваши задачи. - -## Spring Boot Starter -Самый простой способ, если у вас небольшой монолитный Spring Boot проект. - -=== ":simple-apachemaven: Maven" - - ```xml - - dev.struchkov.godfather.telegram - telegram-bot-spring-boot-starter - 0.0.50-SNAPSHOT - - ``` - -=== ":simple-gradle: Gradle" - - ``` c++ - #include - - int main(void) { - std::cout << "Hello world!" << std::endl; - return 0; - } - ``` - -## Quarkus Extension - -На данный момент раздел находится в разработке. - -=== ":simple-apachemaven: Maven" - - ``` - - ``` - -=== ":simple-gradle: Gradle" - - ``` - - ``` - -### Reactive - -На данный момент раздел находится в разработке. - -## Основные зависимости проекта -Вы можете добавить основные зависимости в свой проект и сконфигурировать его более тонко под ваши нужды. Однако для этого потребуется хорошее знание архитектуры проекта. - -Этот вариант подойдет вам, если у вас используется микросервисная архитектура. Так как логично разделить стадии получения, обработки и отправки сообщений на разные сервисы. - -Также этот вариант подойдет вам, если вы используете менее популярный фреймворк, так как основные зависимости написаны без привязки к какому-то конкретному фреймворку. - -Всего основных зависимостей три: - -=== ":simple-spring: Spring" - Эти зависимости подойдут вам, если вы используете SpringBoot 3.0.0+ - - === ":simple-apachemaven: Maven" - - ``` xml title="Позволяет получать сообщения" - - ``` - - ``` xml title="Содержит всю логику работы" - - ``` - - ``` xml title="Позволяет отправлять сообщения" - - ``` - - === ":simple-gradle: Gradle" - - ``` xml title="Позволяет получать сообщения" - - ``` - - ``` xml title="Содержит всю логику работы" - - ``` - - ``` xml title="Позволяет отправлять сообщения" - - ``` - -=== ":simple-quarkus: Quarkus" - - Эти зависимости подойдут вам, если вы используете Quarkus 2.16.0+ - - === ":simple-apachemaven: Maven" - - ``` xml title="Позволяет получать сообщения" - - ``` - - ``` xml title="Содержит всю логику работы" - - ``` - - ``` xml title="Позволяет отправлять сообщения" - - ``` - - === ":simple-gradle: Gradle" - - ``` xml title="Позволяет получать сообщения" - - ``` - - ``` xml title="Содержит всю логику работы" - - ``` - - ``` xml title="Позволяет отправлять сообщения" - - ``` \ No newline at end of file diff --git a/documentation/docs/index.md b/documentation/docs/index.md index ecd36ca..3e7afde 100644 --- a/documentation/docs/index.md +++ b/documentation/docs/index.md @@ -6,4 +6,4 @@ title: Home --- -# Godfather Telegram – Фреймворк для создания Telegram ботов \ No newline at end of file +# GitLab Notification – Персональный бот в Telegram для GitLab \ No newline at end of file diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml index 280d5be..deae3fb 100644 --- a/documentation/mkdocs.yml +++ b/documentation/mkdocs.yml @@ -9,12 +9,10 @@ repo_name: uPagge/gitlab-notification nav: - 'index.md' - 'Быстрый старт': - - 'getting-started/installing-dependencies.md' - 'getting-started/configuration.md' -# - 'Гайды': - 'Архитектура': - 'architecture/concept.md' -# - 'ChangeLog': + - 'changelog.md': theme: name: material