Skip to content

docs: добавить Wiki-страницы проекта BioETL на русском языке#3199

Open
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
devin/1777232744-add-wiki-pages
Open

docs: добавить Wiki-страницы проекта BioETL на русском языке#3199
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
devin/1777232744-add-wiki-pages

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot commented Apr 26, 2026

Summary

Добавлены 9 Wiki-страниц проекта BioETL на русском языке в docs/wiki/, а также скрипт для развёртывания в GitHub Wiki.

Changes

  • Добавлена docs/wiki/Home.md — главная страница с оглавлением и ключевыми особенностями
  • Добавлена docs/wiki/Архитектура.md — гексагональная архитектура (5 слоёв, Mermaid-диаграмма)
  • Добавлена docs/wiki/Medallion-архитектура-данных.md — медальонная архитектура (Bronze/Silver/Gold)
  • Добавлена docs/wiki/Провайдеры-данных.md — таблица всех 8 провайдеров с описаниями
  • Добавлена docs/wiki/Быстрый-старт.md — установка, настройка, запуск пайплайнов
  • Добавлена docs/wiki/Доменный-слой.md — DDD-паттерны (Ports, Aggregates, Value Objects и др.)
  • Добавлена docs/wiki/Тестирование.md — стратегия тестирования, инструменты, команды
  • Добавлена docs/wiki/Конфигурация.md — переменные окружения и YAML-конфигурации
  • Добавлена docs/wiki/ADR-реестр.md — реестр всех 45 ADR с описаниями на русском
  • Добавлен docs/wiki/deploy_wiki.sh — скрипт развёртывания в GitHub Wiki
  • Добавлен docs/wiki/README.md — описание содержимого и инструкции по развёртыванию

Type

  • Documentation

Affected layers

(нет изменений в коде)

Test plan

  • Manual verification: проверка корректности Markdown, Mermaid-диаграмм, внутренних ссылок между страницами

Architecture verification evidence

(не применимо — только документация)

Checklist

  • No new import boundary violations (ARCH-001)
  • No hardcoded secrets (AP-005)
  • Type annotations on all public functions (TYPE-001) — N/A (no code changes)
  • Tests added/updated for new code (TEST-002) — N/A (no code changes)

Развёртывание в GitHub Wiki

После мержа PR, для публикации страниц в GitHub Wiki:

  1. Инициализируйте Wiki через GitHub UI: https://github.com/SatoryKono/BioactivityDataAcquisition/wiki/_new (создайте пустую Home-страницу)
  2. Запустите скрипт: bash docs/wiki/deploy_wiki.sh

Link to Devin session: https://app.devin.ai/sessions/9ed0b2a21b9745ef93ebd7ad58fdd24d
Requested by: @SatoryKono


Open in Devin Review

Добавлены 9 Wiki-страниц в docs/wiki/:
- Home.md — главная страница
- Архитектура.md — гексагональная архитектура
- Medallion-архитектура-данных.md — медальонная архитектура
- Провайдеры-данных.md — источники данных
- Быстрый-старт.md — установка и запуск
- Доменный-слой.md — DDD-паттерны
- Тестирование.md — стратегия тестирования
- Конфигурация.md — переменные окружения и YAML
- ADR-реестр.md — реестр архитектурных решений

Включён скрипт deploy_wiki.sh для развёртывания в GitHub Wiki.

Co-Authored-By: Новиков Федор <821311@gmail.com>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Apr 26, 2026
devin-ai-integration[bot]

This comment was marked as resolved.

Co-Authored-By: Новиков Федор <821311@gmail.com>
devin-ai-integration[bot]

This comment was marked as resolved.

Co-Authored-By: Новиков Федор <821311@gmail.com>
@sonarqubecloud
Copy link
Copy Markdown

Quality Gate Failed Quality Gate failed

Failed conditions
1 New issue

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant