Skip to content

Репозиторий для хранения и деплоя API-документаций проекта

Notifications You must be signed in to change notification settings

TaskConverterAI/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🧠 TaskConverterAI API Docs

TaskConverterAI API Docs — это статическое веб-приложение, служащее центральной точкой доступа к микросервисам проекта TaskConverterAI.
На главной странице отображается список сервисов с кратким описанием и ссылками на их OpenAPI (Swagger) документации.

🧩 Концепция

  • Главная страница (index.html) — отображает карточки микросервисов.
  • Каждая карточка содержит:
    • Название сервиса
    • Краткое описание
    • Ссылку на страницу с документацией (встроенный Swagger UI)
  • Swagger-документации подключаются из YML-файлов (OpenAPI 3.0).

🌐 Деплой

Проект автоматически публикуется на GitHub Pages после слияния изменений в ветку main.

Публичный URL:

🔗 https://taskconverterai.github.io/docs/

⚙️ Процесс деплоя

  1. Разработка ведётся в отдельных ветках (например, feature/... или dev).
  2. После завершения задачи создаётся Pull Request в ветку main.
  3. После слияния PR, автоматически запускается GitHub Actions workflow:
    • Проверяет репозиторий
    • Собирает статику из папки taskconverterai/
    • Публикует сайт на GitHub Pages

About

Репозиторий для хранения и деплоя API-документаций проекта

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published